vdgiapp/sProgress

sProgress

Created by Giapp, based on progress2 by Southclaws with new features.

• Require YSI-Includes
• Support open.mp
• Support samp-textdraw-streamer

NEW FEATURES:

  - Use TextDraw sprites (LD_SPAC:white) instead of box.
  - New types (direction): Middle-to-edge direction, vertically and horizontally.
  - Border size (set to 0.0 to hide background bar).
  - Sub bar with override mode (sub bar cant be use with middle-to-edge direction).

INSTALLATION

Include in your code and begin using the library:

#include <open.mp>
#include <textdraw-streamer>
#include <sProgress>

EXPLAINATION

Bars and override mode

Types

DEFINES

Values

• MAX_SPROGRESS_BARS: Defaults to the player textdraw limit divided by 4 (64).
• INVALID_SP_BAR_VALUE: Invalid return value for interface functions.
• INVALID_SP_BAR_ID: Invalid bar ID value.

Types

• SP_BAR_TYPE_RIGHT: Left-to-right bar direction.
• SP_BAR_TYPE_LEFT: Right-to-left bar direction.
• SP_BAR_TYPE_UP: Bottom to top bar direction.
• SP_BAR_TYPE_DOWN: Top to bottom bar direction.
• SP_BAR_TYPE_MID_V: Middle-to-edge bar direction, vertically (sub bar will not work with this type).
• SP_BAR_TYPE_MID_H: Middle-to-edge bar direction, horizontally (sub bar will not work with this type).

FUNCTIONS

Main

• CreatePlayerSProgress(playerid, Float:x, Float:y, Float:w, Float:h, Float:max = 100.0, type = SP_BAR_TYPE_RIGHT): Create a progress bar for a player, return the bar ID if its created.
• DestroyPlayerSProgress(playerid, barid): Destroy a player's progress bar.
• DestroyAllPlayerSProgress(playerid): Destroy all progress bars for a player.
• ShowPlayerSProgress(playerid, barid): Shows a player's progress bar to them.
• HidePlayerSProgress(playerid, barid): Hides a player's progress bar from them.
• bool:IsValidPlayerSProgress(playerid, barid): Returns true if the input bar ID is valid and exists.
• bool:IsPlayerSProgressVisible(playerid, barid): Return true if the input bar ID is visible to player.

Colour

• GetPlayerSProgressBackColour(playerid, barid): Returns the background colour of a progress bar.
• SetPlayerSProgressBackColour(playerid, barid, colour): Sets the background colour of a progress bar.
• GetPlayerSProgressFillColour(playerid, barid): Returns the fill colour of a progress bar.
• SetPlayerSProgressFillColour(playerid, barid, colour): Sets the fill colour of a progress bar.
• GetPlayerSProgressMainColour(playerid, barid): Returns the main colour of a progress bar.
• SetPlayerSProgressMainColour(playerid, barid, colour): Sets the main colour of a progress bar.
• GetPlayerSProgressSubColour(playerid, barid): Returns the sub colour of a progress bar.
• SetPlayerSProgressSubColour(playerid, barid, colour): Sets the sub colour of a progress bar.

Position

• GetPlayerSProgressPos(playerid, barid, &Float:x, &Float:y): Returns the on-screen position of the specified progress bar.
• SetPlayerSProgressPos(playerid, barid, Float:x, Float:y): Updates the position for a progress bar.

Width/height (greater or equal 0)

• Float:GetPlayerSProgressWidth(playerid, barid): Returns the width of a progress bar.
• SetPlayerSProgressWidth(playerid, barid, Float:w): Updates the width of a progress bar.
• Float:GetPlayerSProgressHeight(playerid, barid): Returns the height of a progress bar.
• SetPlayerSProgressHeight(playerid, barid, Float:h): Updates the height of a progress bar.

Border size (greater or equal 0)

• Float:GetPlayerSProgressBorderSize(playerid, barid): Return border size of a progress bar.
• SetPlayerSProgressBorderSize(playerid, barid, Float:b): Updates border size of a progress bar.

Override

• bool:GetPlayerSProgressOverride(playerid, barid): Return true if the input bar ID uses override mode.
• SetPlayerSProgressOverride(playerid, barid, bool:override): Set override mode of a progress bar.

Type

• GetPlayerSProgressType(playerid, barid): Return the type of a progress bar.
• SetPlayerSProgressType(playerid, barid, type): Updates the type of a progress bar.

Main value (greater or equal 0)

• Float:GetPlayerSProgressMinValue(playerid, barid): Return the min value of a progress bar.
• Float:GetPlayerSProgressMaxValue(playerid, barid): Return the max value of a progress bar.
• Float:GetPlayerSProgressValue(playerid, barid): Return the value of a progress bar.
• SetPlayerSProgressMinValue(playerid, barid, Float:val): Set the min value of a progress bar.
• SetPlayerSProgressMaxValue(playerid, barid, Float:val): Set the max value of a progress bar.
• SetPlayerSProgressValue(playerid, barid, Float:val): Set the value of a progress bar.

Sub value (greater or equal 0)

• Float:GetPlayerSProgressSubMinValue(playerid, barid): Return the sub min value of a progress bar.
• Float:GetPlayerSProgressSubMaxValue(playerid, barid): Return the sub max value of a progress bar.
• SetPlayerSProgressSubMinValue(playerid, barid, Float:val): Set the sub min value of a progress bar.
• SetPlayerSProgressSubMaxValue(playerid, barid, Float:val): Set the sub max value of a progress bar.

HOOKED

• OnScriptInit: When y_iterate is used, initialises iterators.
• OnPlayerDisconnect: To automatically destroy bars when a player disconnects.
• OnScriptExit