Files
SessionGoldTracker/docs/blizzard-api/Blizzard_APIDocumentationGenerated/CooldownViewerDocumentation.lua
T
2026-10-15 14:27:00 +11:00

167 lines
4.3 KiB
Lua

local CooldownViewer =
{
Name = "CooldownViewer",
Type = "System",
Namespace = "C_CooldownViewer",
Environment = "All",
Functions =
{
{
Name = "GetCooldownViewerCategorySet",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "category", Type = "CooldownViewerCategory", Nilable = false },
{ Name = "allowUnlearned", Type = "bool", Nilable = false, Default = false },
},
Returns =
{
{ Name = "cooldownIDs", Type = "table", InnerType = "number", Nilable = false },
},
},
{
Name = "GetCooldownViewerCooldownInfo",
Type = "Function",
MayReturnNothing = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "cooldownID", Type = "number", Nilable = false },
},
Returns =
{
{ Name = "cooldownInfo", Type = "CooldownViewerCooldown", Nilable = false },
},
},
{
Name = "GetGroupBuffItems",
Type = "Function",
Returns =
{
{ Name = "groupBuffItems", Type = "table", InnerType = "GroupBuffItem", Nilable = false },
},
},
{
Name = "GetLayoutData",
Type = "Function",
Returns =
{
{ Name = "data", Type = "cstring", Nilable = false },
},
},
{
Name = "GetValidAlertTypes",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "cooldownID", Type = "number", Nilable = false },
},
Returns =
{
{ Name = "validAlertTypes", Type = "table", InnerType = "CooldownViewerAlertEventType", Nilable = false },
},
},
{
Name = "IsCooldownViewerAvailable",
Type = "Function",
Returns =
{
{ Name = "isAvailable", Type = "bool", Nilable = false },
{ Name = "failureReason", Type = "string", Nilable = false },
},
},
{
Name = "SetLayoutData",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "data", Type = "cstring", Nilable = false },
},
},
},
Events =
{
{
Name = "CooldownViewerDataLoaded",
Type = "Event",
LiteralName = "COOLDOWN_VIEWER_DATA_LOADED",
SynchronousEvent = true,
},
{
Name = "CooldownViewerSpellOverrideUpdated",
Type = "Event",
LiteralName = "COOLDOWN_VIEWER_SPELL_OVERRIDE_UPDATED",
SynchronousEvent = true,
Payload =
{
{ Name = "baseSpellID", Type = "number", Nilable = false, Documentation = { "The base spell that is either being overridden or losing its override spell." } },
{ Name = "overrideSpellID", Type = "number", Nilable = true, Documentation = { "The spell overriding the base spell. A nil value indicates that the override spell is being removed from the base spell." } },
},
},
{
Name = "CooldownViewerTableHotfixed",
Type = "Event",
LiteralName = "COOLDOWN_VIEWER_TABLE_HOTFIXED",
SynchronousEvent = true,
},
},
Tables =
{
{
Name = "CooldownViewerCooldown",
Type = "Structure",
Fields =
{
{ Name = "cooldownID", Type = "number", Nilable = false },
{ Name = "spellID", Type = "number", Nilable = true },
{ Name = "spellCategoryID", Type = "number", Nilable = true },
{ Name = "overrideSpellID", Type = "number", Nilable = true },
{ Name = "overrideTooltipSpellID", Type = "number", Nilable = true },
{ Name = "equipSlot", Type = "luaIndex", Nilable = true },
{ Name = "buffSlot", Type = "luaIndex", Nilable = true },
{ Name = "linkedSpellIDs", Type = "table", InnerType = "number", Nilable = false },
{ Name = "selfAura", Type = "bool", Nilable = false },
{ Name = "hasAura", Type = "bool", Nilable = false },
{ Name = "charges", Type = "bool", Nilable = false },
{ Name = "isKnown", Type = "bool", Nilable = false },
{ Name = "isInvisible", Type = "bool", Nilable = false },
{ Name = "flags", Type = "CooldownSetSpellFlags", Nilable = false },
{ Name = "category", Type = "CooldownViewerCategory", Nilable = false },
},
},
{
Name = "GroupBuffItem",
Type = "Structure",
Fields =
{
{ Name = "spellID", Type = "number", Nilable = false },
{ Name = "name", Type = "cstring", Nilable = false },
{ Name = "iconID", Type = "fileID", Nilable = false },
{ Name = "flags", Type = "GroupBuffItemFlags", Nilable = false },
{ Name = "isKnown", Type = "bool", Nilable = false },
},
},
},
Predicates =
{
},
};
APIDocumentation:AddDocumentationTable(CooldownViewer);