Advanced Status 0.1.15

Useful auxiliary plugin that allows other plugins to customize the status bar through an API.

Note: AdvancedStatus does not display any bars on its own. This is done by other plugins that work with it.

An example plugin demonstrating interaction with AdvancedStatus.

 

• The ability to specify the frequency of calculating the number of bars;
• The ability to specify the order of the bar;
• The ability to change the height of the bar;
• The abillity to customize the color and transparency of the background;
• The ability to set a material for the background;
• The ability to switch between CuiRawImageComponent and CuiImageComponent for the image;
• The ability to get images from the local folder(*SERVER*\oxide\data\AdvancedStatus\Images);
• The abillity to set own image and customize the color and transparency of the image;
• The abillity to set sprite instead of the image;
• The ability to specify custom text;
• The ability to customize the color, size and font of the text;
• No need to pass all parameters;
• No need to manually delete your bar when unloading your plugin.

 

{
  "Enable image load messages in the console?": false,
  "Client Status Bar Count Interval": 0.5,
  "Bar - Display Layer(If you have button bars, it's advisable to use Hud)": "Under",
  "Bar - Left to Right": true,
  "Bar - Offset Between": 2,
  "Bar - Default Height": 26,
  "Main - Default Color": "#505F75",
  "Main - Default Transparency": 0.7,
  "Main - Default Material(empty to disable)": "",
  "Image - Default Color": "#6B7E95",
  "Image - Default Transparency": 1.0,
  "Text - Default Size": 12,
  "Text - Default Color": "#FFFFFF",
  "Text - Default Font(https://umod.org/guides/rust/basic-concepts-of-gui#fonts)": "RobotoCondensed-Bold.ttf",
  "Text - Default Offset Horizontal": 0,
  "SubText - Default Size": 12,
  "SubText - Default Color": "#FFFFFF",
  "SubText - Default Font(https://umod.org/guides/rust/basic-concepts-of-gui#fonts)": "RobotoCondensed-Bold.ttf",
  "Progress - Default Color": "#89B840",
  "Progress - Default Transparency": 0.7,
  "Progress - Default OffsetMin": "25 2.5",
  "Progress - Default OffsetMax": "-3.5 -3.5",
  "Version": {
    "Major": 0,
    "Minor": 1,
    "Patch": 15
  }
}

Note: Default values will be used if the external plugin does not pass the property itself.

 

EN:
{
  "MsgDays": "d",
  "MsgHours": "h",
  "MsgMinutes": "m",
  "MsgSeconds": "s"
}
RU:
{
  "MsgDays": "д",
  "MsgHours": "ч",
  "MsgMinutes": "м",
  "MsgSeconds": "с"
}

 

• OnAdvancedStatusLoaded:
  • Called after the AdvancedStatus plugin is fully loaded and ready.
• OnPlayerGainedBuildingPrivilege:
  • Called after the player enters their building privilege.
• OnPlayerLostBuildingPrivilege:
  • Called after the player exits their building privilege.

 

void OnAdvancedStatusLoaded()
{
  Puts("The AdvancedStatus plugin is loaded and ready to go!");
}

void OnPlayerGainedBuildingPrivilege(BasePlayer player)
{
  Puts($"{player.displayName} entered the authorized building privilege zone.");
}

void OnPlayerLostBuildingPrivilege(BasePlayer player)
{
  Puts($"{player.displayName} exited the authorized building privilege zone.");
}

 

[PluginReference]
private Plugin AdvancedStatus;

There are 13 methods:

• IsReady
• CreateBar
• UpdateContent
• DeleteBar
• DeleteCategory
• DeleteAllBars
• LoadImages
• LoadImage
• CopyImage
• DeleteImages
• DeleteImage
• BarExists
• InBuildingPrivilege 

 

There are 5 types of bar:

• Default - A simple bar that displays the provided information. Does not update the value of SubText by itself;
• Timed - Similar to the default bar, but it automatically disappears after the specified time in the TimeStamp parameter;
• TimeCounter - The SubText shows the remaining time until TimeStamp. Also automatically removed upon expiration of the TimeStamp;
• TimeProgress - Similar to the Timed bar, but additionally features an automatically filling progress bar;
• TimeProgressCounter - Similar to the TimeCounter bar, but additionally features an automatically filling progress bar.

 

IsReady:

Used to check if the AdvancedStatus plugin is loaded and ready to work.

The IsReady method returns true if it is ready, or null if it is not.

AdvancedStatus?.Call("IsReady");//Calling the IsReady method. If the result is not null(bool true), the plugin is ready.

 

CreateBar:

Used to create a bar or update bar values for a player.

To call the CreateBar method, you need to pass 2 parameters. The first one is BasePlayer or <ulong>playerID. The second one is a dictionary with the parameters you need.

In the CreateBar method, all parameters are optional, except for two:

• Id;
• Plugin.

Parameters not specified when creating a new bar will use the values set in the AdvancedStatus plugin's configuration file.

Parameters not specified during bar update will retain the values they had before the update.

Note: The plugin does not update values automatically, you need to manually send new values.

Dictionary<string, object> parameters = new Dictionary<string, object>
{
  { "Id", "AdvancedStatusDemo_1" },					//<string>Unique identifier for the bar in your plugin. ***This is a required field.
  { "BarType", "Default" },						//<string>Type of the bar. There are 4 types: Default, Timed, TimeCounter and TimeProgress.
  { "Plugin", "AdvancedStatusDemo" },					//<string>Name of your plugin. ***This is a required field.
  { "Category", "Default" },						//<string>Internal plugin category of the bar.
  { "Order", 10 },							//<int>The position of your bar relative to others. Order is determined by increasing values(ASC).
  { "Height", 26 },							//<int>The height of your bar. A standard bar is 26 pixels.
  { "Main_Color", "#505F75" },						//<string>HTML Hex color of the bar background.
  { "Main_Transparency", 0.7f },					//<float>Transparency of the bar background.
  { "Main_Material", "assets/content/ui/uibackgroundblur.mat" },	//<string>Material of the bar background(empty to disable).
  { "Image", "scrap" },							//<string>Name of the image saved in the ImageLibrary or a direct link to the image if ImageLibrary is not used.
  { "Image_Local", "AdvancedStatusDemo_Scrap" },			//<string>The name of the image file(without its extension) located in *SERVER*\data\AdvancedStatus\Images. Leave empty to use Image.
  { "Image_Sprite", "" },						//<string>Sprite image of the bar. Leave empty to use Image_Local or Image.
  { "Is_RawImage", true },						//<bool>Which type of image will be used? True - CuiRawImageComponent. False - CuiImageComponent.
  { "Image_Color", "#6B7E95" },						//<string>HTML Hex color of the bar image.
  { "Image_Transparency", 1.0f },					//<float>Transparency of the image.
  { "Text", "Scrap" },							//<string>Main text.
  { "Text_Size", 12 },							//<int>Size of the main text.
  { "Text_Color", "#FFFFFF" },						//<string>HTML Hex color of the main text.
  { "Text_Font", "RobotoCondensed-Bold.ttf" },				//<string>Font of the main text.
  { "Text_Offset_Horizontal", 0 },					//<int>Horizontal offset for the main text.
  { "SubText", "35" },							//<string>Sub text.
  { "SubText_Size", 12 },						//<int>Size of the sub text.
  { "SubText_Color", "#FFFFFF" },					//<string>HTML Hex color of the sub text.
  { "SubText_Font", "RobotoCondensed-Bold.ttf" },			//<string>Font of the sub text.
  { "TimeStampStart", Network.TimeEx.currentTimestamp },		//<double>Responsible for specifying the start point of the time reference and 0% for TimeProgress and TimeProgressCounter bars. Used if the bar type is Timed, TimeCounter, TimeProgress or TimeProgressCounter.
  { "TimeStamp", Network.TimeEx.currentTimestamp + 6 },			//<double>Specifies the end time point after which the bar will be destroyed and 100% for TimeProgress and TimeProgressCounter bars. Used if the bar type is Timed, TimeCounter, TimeProgress or TimeProgressCounter.
  { "TimeStampDestroy", Network.TimeEx.currentTimestamp + 3 },		//<double>If TimeStampDestroy is specified and it is less than TimeStamp, the bar will be destroyed by TimeStampDestroy. Used if the bar type is Timed, TimeCounter, TimeProgress or TimeProgressCounter.
  { "Progress", (float)35 / 100f },					//<float>Progress. From 0.0 to 1.0.
  { "Progress_Color", "#89B840" },					//<string>Progress color.
  { "Progress_Transparency", 1f },					//<float>Progress transparency.
  { "Progress_OffsetMin", "25 2.5" },					//<string>Progress OffsetMin: "*left* *bottom*".
  { "Progress_OffsetMax", "-3.5 -3.5" },				//<string>Progress OffsetMax: "*right* *top*".
  { "Command", "kit" }							//<string>If the field is not empty, the bar becomes clickable, and the specified command is executed upon clicking. Note: the command must be covalence.
};

AdvancedStatus?.Call("CreateBar", player.userID.Get(), parameters);	//Calling the CreateBar method with the passing of BasePlayer/playerID and a dictionary containing the required parameters.

 

UpdateContent:

Used to update only the content of an existing status bar.

To call the UpdateContent method, you need to pass 2 parameters. The first one is BasePlayer or <ulong>playerID. The second one is a dictionary with the parameters you need.

In the UpdateBar method, all parameters are optional, except for two:

• Id;
• Plugin.

var parameters = new Dictionary<string, object>
{
  { "Id", "MyID" },								//<string>Unique identifier for the bar in your plugin. ***This is a required field.
  { "Plugin", Name },								//<string>Name of your plugin. ***This is a required field.
  { "Text", "MyText" },								//<string>Main text.
  { "SubText", "MyText" },							//<string>Sub text.
  { "Progress", (float)amount / 100f },						//<float>Progress. From 0.0 to 1.0.
};

AdvancedStatus?.Call("UpdateContent", player.userID.Get(), parameters);		//Calling the UpdateContent method with the passing of BasePlayer/playerID and a dictionary containing the required parameters.

 

DeleteBar:

Used to remove the bar for a player.

There are two methods for removing a bar by ID:

• with specifying a particular player;
  • To call this method, you need to pass 3 parameters. The first one is BasePlayer or <ulong>playerID. The second one is Id of your bar and the third one is name of your plugin.
• without specifying a particular player (which removes it for all players)
  • To call this method, you need to pass 2 parameters. The first one is Id of your bar and the second one is name of your plugin.

AdvancedStatus?.Call("DeleteBar", player.userID.Get(), barID, Name);	//Calling the DeleteBar method with the passing of BasePlayer/playerID, ID of the bar and the name of your plugin.
AdvancedStatus?.Call("DeleteBar", barID, Name);				//Calling the DeleteBar method with the passing of ID of the bar and the name of your plugin.

If you try to delete a bar that doesn't exist, nothing bad will happen. So feel free to delete the bar without checking its existence.

P.S. When unloading your plugin, there is no need to manually delete bars for players, AdvancedStatus will handle it automatically.

 

DeleteCategory:

Used to remove all bars associated with the plugin's category.

To call the DeleteCategory method, you need to pass 2 parameters. The first one is category and the second one is name of your plugin.

AdvancedStatus?.Call("DeleteCategory", "Default", Name);//Calling the DeleteCategory method by passing the category and name of your plugin

 

DeleteAllBars:

Used to remove all bars associated with the plugin.

To call the DeleteAllBars method, you need to pass only 1 parameter. It is name of your plugin.

AdvancedStatus?.Call("DeleteAllBars", Name);//Calling the DeleteAllBars method, passing the name of your plugin

 

LoadImages:

Used to check if the local images specified in the list are loaded.
If any of the images are not loaded but their files exist in the images folder, the plugin will load them.

To call the LoadImages method, you need to pass only 2 parameters. The first one is the <List<string>>list of image's name and the second one(optional) is <bool>force, which, if set to true, will force reload the image even if it already exists.

AdvancedStatus?.Call("LoadImages", list, false);//Calling the LoadImages method, passing a list of image names

 

LoadImage:

Used to check if the local image is loaded.
If the file is not loaded and exists in the images folder, the plugin will load it.

To call the LoadImage method, you need to pass 2 parameters. The first one is the <string>image's name and the second one(optional) is <bool>force, which, if set to true, will force reload the image even if it already exists.

AdvancedStatus?.Call("LoadImage", imgName, false);//Calling the LoadImage method, passing an image's name

 

CopyImage:

Used to create and load a copy of an existing image.

To call the CopyImage method, you need to pass 3 parameters. The first parameter is the <string>source image's name, the second parameter is the <string>new image's name and the third one(optional) is <bool>force, which, if set to true, will force copy and reload the image even if it already exists.

AdvancedStatus?.Call("CopyImage", "ZoneStatus_Default", "ZoneStatus_NewZone", false);//Calling CopyImage, passing the source image name and the new image name.

 

DeleteImages:

Used to delete a list of images and their files.

To call the DeleteImages method, you need to pass 2 parameters. The first one is the <List<string>>list of image's name and the second one(optional) parameter is <bool>deleteFile, which, if set to true, will delete image's file too.

AdvancedStatus?.Call("DeleteImages", list, true);//Calling DeleteImages, passing a list of image names.

 

DeleteImage:

Used for removing the image and the image file.

To call the DeleteImage method, you need to pass 2 parameters. The first parameter is the <string>image's name and the second one(optional) parameter is <bool>deleteFile, which, if set to true, will delete image's file too.

AdvancedStatus?.Call("DeleteImage", "ZoneStatus_NewZone", true);//Calling DeleteImage, passing the image name.

 

BarExists:

Used to check if the specified bar exists.

To call the BarExists method, you need to pass 3 parameters. The first one is BasePlayer or <ulong>playerID. The second one is Id of your bar. And the third one is name of your plugin.

(bool)AdvancedStatus?.Call("BarExists", player.userID.Get(), barID, Name);//Calling the BarExists method with the passing of BasePlayer/playerID, ID of the bar and name of your plugin.

 

InBuildingPrivilege:

Used to check if the player has authorized building privileges.

To call the InBuildingPrivilege method, you need to pass  BasePlayer or <ulong>playerID.

(bool)AdvancedStatus?.Call("InBuildingPrivilege", player.userID.Get(), false);//Checking if the player has Building Privilege.