Advanced Status 0.1.14

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 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. Additionally, customization options for 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.

 

{
  "Client Status Bar Count Interval": 0.5,
  "Bar - Display Layer(https://umod.org/guides/rust/basic-concepts-of-gui#layers)": "Hud",
  "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": 14
  }
}

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": "с"
}

 

• OnPlayerGainedBuildingPrivilege:
  • Called after the player enters their building privilege.

• OnPlayerLostBuildingPrivilege:
  • Called after the player exits their building privilege.

 

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.");
}

 

There are 7 methods:

• CreateBar
• UpdateContent
• DeleteBar
• DeleteCategory
• DeleteAllBars
• BarExists
• InBuildingPrivilege 

 

There are 4 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 TimeCounter bar, but additionally features a progress bar.

 

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", _barID },							//<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", Name },							//<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_Sprite", "" },						//<string>Sprite image of the bar. (If empty, Image will be used as the 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.
  { "TimeStamp", Network.TimeEx.currentTimestamp + 6 },			//<double>Used if the bar type is Timed, TimeCounter or TimeProgress.
  { "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, 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, 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, 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

 

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, 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, false);//Checking if the player has Building Privilege.