summaryrefslogtreecommitdiffstats
path: root/Server
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--Server/Plugins/APIDump/APIDesc.lua189
1 files changed, 189 insertions, 0 deletions
diff --git a/Server/Plugins/APIDump/APIDesc.lua b/Server/Plugins/APIDump/APIDesc.lua
index c84260903..411ee95f4 100644
--- a/Server/Plugins/APIDump/APIDesc.lua
+++ b/Server/Plugins/APIDump/APIDesc.lua
@@ -1569,6 +1569,128 @@ end
},
Notes = "Sends a BlockChange packet to the client. This can be used to create fake blocks only for that player.",
},
+ SendBossBarAdd =
+ {
+ Params =
+ {
+ {
+ Name = "UniqueID",
+ Type = "number",
+ },
+ {
+ Name = "Title",
+ Type = "cCompositeChat",
+ },
+ {
+ Name = "FractionFilled",
+ Type = "number",
+ },
+ {
+ Name = "Colour",
+ Type = "BossBarColor",
+ },
+ {
+ Name = "DivisionType",
+ Type = "BossBarDivisionType",
+ },
+ {
+ Name = "DarkenSky",
+ Type = "boolean",
+ },
+ {
+ Name = "PlayEndMusic",
+ Type = "boolean",
+ },
+ {
+ Name = "CreateFog",
+ Type = "boolean",
+ },
+ },
+ Notes = "Creates a boss bar on the client's UI. The boss bar is independent of any entity and has a lifetime and properties fully controlled by the plugin. Plugins are responsible for assigning a unique ID and removal.",
+ },
+ SendBossBarUpdateFlags =
+ {
+ Params =
+ {
+ {
+ Name = "UniqueID",
+ Type = "number",
+ },
+ {
+ Name = "DarkenSky",
+ Type = "boolean",
+ },
+ {
+ Name = "PlayEndMusic",
+ Type = "boolean",
+ },
+ {
+ Name = "CreateFog",
+ Type = "boolean",
+ },
+ },
+ Notes = "Updates a boss bar on the client's UI. Only updates some meta flags for additional effects.",
+ },
+ SendBossBarUpdateStyle =
+ {
+ Params =
+ {
+ {
+ Name = "UniqueID",
+ Type = "number",
+ },
+ {
+ Name = "Color",
+ Type = "BossBarColor",
+ },
+ {
+ Name = "DivisionType",
+ Type = "BossBarDivisionType",
+ },
+ },
+ Notes = "Updates a boss bar on the client's UI. Only updates the visuals of the Boss Bar.",
+ },
+ SendBossBarUpdateTitle =
+ {
+ Params =
+ {
+ {
+ Name = "UniqueID",
+ Type = "number",
+ },
+ {
+ Name = "Title",
+ Type = "cCompositeChat",
+ },
+ },
+ Notes = "Updates a boss bar on the client's UI. Only Updates the text at the top.",
+ },
+ SendBossBarRemove =
+ {
+ Params =
+ {
+ {
+ Name = "UniqueID",
+ Type = "number",
+ },
+ },
+ Notes = "Removes the boss bar with the given ID from the client's UI.",
+ },
+ SendBossBarUpdateHealth =
+ {
+ Params =
+ {
+ {
+ Name = "UniqueID",
+ Type = "number",
+ },
+ {
+ Name = "FractionFilled",
+ Type = "number",
+ },
+ },
+ Notes = "Updates the health displayed by the boss bar with the given ID.",
+ },
SendEntityAnimation =
{
Params =
@@ -13120,6 +13242,73 @@ end
}, -- ConstantGroups
}, -- cWindow
+ BossBarColor =
+ {
+ Desc = [[
+ An enumeration of boss bar display colours which can be used with {{cClientHandle#SendBossBarAdd|SendBossBarAdd}}.
+ ]],
+ Constants =
+ {
+ Pink =
+ {
+ Notes = "A pink boss bar."
+ },
+ Blue =
+ {
+ Notes = "A blue boss bar."
+ },
+ Red =
+ {
+ Notes = "A red boss bar."
+ },
+ Green =
+ {
+ Notes = "A green boss bar."
+ },
+ Yellow =
+ {
+ Notes = "A yellow boss bar."
+ },
+ Purple =
+ {
+ Notes = "A purple boss bar."
+ },
+ White =
+ {
+ Notes = "A white boss bar."
+ },
+ },
+ },
+ BossBarDivisionType =
+ {
+ Desc = [[
+ An enumeration of boss bar division types which can be used with {{cClientHandle#SendBossBarAdd|SendBossBarAdd}}.
+ These constants control the number of notches the bar itself renders with.
+ ]],
+ Constants =
+ {
+ None =
+ {
+ Notes = "A completely smooth boss bar."
+ },
+ SixNotches =
+ {
+ Notes = "A six-notch'd boss bar."
+ },
+ TenNotches =
+ {
+ Notes = "A ten-notch'd boss bar."
+ },
+ TwelveNotches =
+ {
+ Notes = "A twelve notch'd boss bar."
+ },
+ TwentyNotches =
+ {
+ Notes = "A twenty notch'd boss bar."
+ },
+ },
+ },
EffectID =
{
Desc = [[