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

684 lines
18 KiB
Lua

local UnitAura =
{
Name = "UnitAuras",
Type = "System",
Namespace = "C_UnitAuras",
Environment = "All",
Functions =
{
{
Name = "AddAuraSound",
Type = "Function",
HasRestrictions = true,
SecretArguments = "AllowedWhenUntainted",
Documentation = { "Registers a sound for an aura event. The sound is stopped after five seconds of playback. The throttleSeconds value must be between 0 and 5 seconds, inclusive." },
Arguments =
{
{ Name = "trigger", Type = "UnitAuraSoundTrigger", Nilable = false },
{ Name = "sound", Type = "UnitAuraSoundInfo", Nilable = false },
},
Returns =
{
{ Name = "auraSoundID", Type = "number", Nilable = true },
},
},
{
Name = "AddBlockedAura",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "unit", Type = "UnitTokenRestrictedForAddOns", Nilable = false },
{ Name = "auraInstanceID", Type = "number", Nilable = false },
},
},
{
Name = "AddPrivateAuraAnchor",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "args", Type = "AddPrivateAuraAnchorArgs", Nilable = false },
},
Returns =
{
{ Name = "anchorID", Type = "number", Nilable = true },
},
},
{
Name = "AuraIsBigDefensive",
Type = "Function",
SecretArguments = "AllowedWhenTainted",
Arguments =
{
{ Name = "spellID", Type = "SpellIdentifier", Nilable = false },
},
Returns =
{
{ Name = "isBigDefensive", Type = "bool", Nilable = false },
},
},
{
Name = "AuraIsPrivate",
Type = "Function",
SecretArguments = "AllowedWhenTainted",
Arguments =
{
{ Name = "spellID", Type = "SpellIdentifier", Nilable = false },
},
Returns =
{
{ Name = "isPrivate", Type = "bool", Nilable = false },
},
},
{
Name = "CancelAuraByInstanceID",
Type = "Function",
RequiresUnitAuraAccess = true,
HasRestrictions = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "unit", Type = "UnitTokenRestrictedForAddOns", Nilable = false, NeverSecret = true },
{ Name = "auraInstanceID", Type = "number", Nilable = false },
},
},
{
Name = "ClearBlockedAuras",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "unit", Type = "UnitTokenRestrictedForAddOns", Nilable = false },
},
},
{
Name = "DoesAuraHaveExpirationTime",
Type = "Function",
RequiresUnitAuraAccess = true,
RequiresValidUnitAuraInstance = true,
SecretWhenUnitAuraRestricted = true,
SecretArguments = "AllowedWhenUntainted",
Documentation = { "Returns true if an aura instance will expire after a certain amount of time." },
Arguments =
{
{ Name = "auraInstanceUnit", Type = "UnitToken", Nilable = false },
{ Name = "auraInstanceID", Type = "number", Nilable = false },
},
Returns =
{
{ Name = "hasExpirationTime", Type = "bool", Nilable = false },
},
},
{
Name = "GetAuraApplicationDisplayCount",
Type = "Function",
RequiresUnitAuraAccess = true,
RequiresValidUnitAuraInstance = true,
SecretWhenUnitAuraRestricted = true,
SecretArguments = "AllowedWhenUntainted",
Documentation = { "Formats a string for displaying the number of applications an aura has present." },
Arguments =
{
{ Name = "auraInstanceUnit", Type = "UnitToken", Nilable = false },
{ Name = "auraInstanceID", Type = "number", Nilable = false },
{ Name = "minDisplayCount", Type = "number", Nilable = false, NeverSecret = true, Default = 2, Documentation = { "Minimum number of applications required; if the application count is below this figure an empty string will be returned." } },
{ Name = "maxDisplayCount", Type = "number", Nilable = true, NeverSecret = true, Documentation = { "Maximum number of applications allowed; if the application count is above this figure then the string '*' will be returned." } },
},
Returns =
{
{ Name = "count", Type = "string", Nilable = false },
},
},
{
Name = "GetAuraBaseDuration",
Type = "Function",
RequiresUnitAuraAccess = true,
RequiresValidUnitAuraInstance = true,
SecretWhenUnitAuraRestricted = true,
SecretArguments = "AllowedWhenTainted",
Documentation = { "Returns the base duration of the given spell (or aura). Takes an optional spellID to use as the new duration if that cannot be derived from the aura, if that value isn't supplied the aura's spellID will be used" },
Arguments =
{
{ Name = "auraInstanceUnit", Type = "UnitToken", Nilable = false },
{ Name = "auraInstanceID", Type = "number", Nilable = false },
{ Name = "spellID", Type = "SpellIdentifier", Nilable = true },
},
Returns =
{
{ Name = "newDuration", Type = "number", Nilable = true },
},
},
{
Name = "GetAuraCasterGUID",
Type = "Function",
RequiresUnitAuraAccess = true,
RequiresValidUnitAuraInstance = true,
SecretWhenUnitAuraRestricted = true,
SecretArguments = "AllowedWhenTainted",
Arguments =
{
{ Name = "auraInstanceUnit", Type = "UnitToken", Nilable = false },
{ Name = "auraInstanceID", Type = "number", Nilable = false },
},
Returns =
{
{ Name = "casterGUID", Type = "WOWGUID", Nilable = true },
},
},
{
Name = "GetAuraDataByAuraInstanceID",
Type = "Function",
RequiresUnitAuraAccess = true,
SecretWhenUnitAuraRestricted = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "unit", Type = "UnitTokenRestrictedForAddOns", Nilable = false, NeverSecret = true },
{ Name = "auraInstanceID", Type = "number", Nilable = false },
},
Returns =
{
{ Name = "aura", Type = "AuraData", Nilable = true },
},
},
{
Name = "GetAuraDataByIndex",
Type = "Function",
RequiresUnitAuraAccess = true,
SecretWhenUnitAuraRestricted = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "unit", Type = "UnitTokenRestrictedForAddOns", Nilable = false },
{ Name = "index", Type = "luaIndex", Nilable = false },
{ Name = "filter", Type = "AuraFilters", Nilable = true },
},
Returns =
{
{ Name = "aura", Type = "AuraData", Nilable = true },
},
},
{
Name = "GetAuraDataBySlot",
Type = "Function",
RequiresUnitAuraAccess = true,
SecretWhenUnitAuraRestricted = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "unit", Type = "UnitTokenRestrictedForAddOns", Nilable = false, NeverSecret = true },
{ Name = "slot", Type = "number", Nilable = false },
},
Returns =
{
{ Name = "aura", Type = "AuraData", Nilable = true },
},
},
{
Name = "GetAuraDataBySpellName",
Type = "Function",
SecretWhenUnitAuraRestricted = true,
RequiresNonSecretAura = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "unit", Type = "UnitTokenRestrictedForAddOns", Nilable = false, NeverSecret = true },
{ Name = "spellName", Type = "cstring", Nilable = false },
{ Name = "filter", Type = "AuraFilters", Nilable = true },
},
Returns =
{
{ Name = "aura", Type = "AuraData", Nilable = true },
},
},
{
Name = "GetAuraDispelTypeColor",
Type = "Function",
RequiresUnitAuraAccess = true,
RequiresValidUnitAuraInstance = true,
SecretWhenUnitAuraRestricted = true,
SecretWhenCurveSecret = true,
SecretArguments = "AllowedWhenUntainted",
Documentation = { "Queries the dispel type associated with an aura instance and remaps it to a color via a curve, with the dispel type ID used as the 'x' value." },
Arguments =
{
{ Name = "auraInstanceUnit", Type = "UnitToken", Nilable = false },
{ Name = "auraInstanceID", Type = "number", Nilable = false },
{ Name = "curve", Type = "LuaColorCurveObject", Nilable = false },
},
Returns =
{
{ Name = "dispelTypeColor", Type = "colorRGBA", Mixin = "ColorMixin", Nilable = false },
},
},
{
Name = "GetAuraDuration",
Type = "Function",
RequiresUnitAuraAccess = true,
RequiresValidUnitAuraInstance = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "auraInstanceUnit", Type = "UnitToken", Nilable = false },
{ Name = "auraInstanceID", Type = "number", Nilable = false },
},
Returns =
{
{ Name = "duration", Type = "LuaDurationObject", Nilable = false },
},
},
{
Name = "GetAuraSlots",
Type = "Function",
RequiresUnitAuraAccess = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "unit", Type = "UnitTokenRestrictedForAddOns", Nilable = false },
{ Name = "filter", Type = "AuraFilters", Nilable = true },
{ Name = "maxSlots", Type = "number", Nilable = true },
{ Name = "continuationToken", Type = "number", Nilable = true },
},
Returns =
{
{ Name = "outContinuationToken", Type = "number", Nilable = true },
{ Name = "slots", Type = "number", Nilable = false, StrideIndex = 1 },
},
},
{
Name = "GetBuffDataByIndex",
Type = "Function",
RequiresUnitAuraAccess = true,
SecretWhenUnitAuraRestricted = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "unit", Type = "UnitTokenRestrictedForAddOns", Nilable = false },
{ Name = "index", Type = "luaIndex", Nilable = false },
{ Name = "filter", Type = "AuraFilters", Nilable = true },
},
Returns =
{
{ Name = "aura", Type = "AuraData", Nilable = true },
},
},
{
Name = "GetCooldownAuraBySpellID",
Type = "Function",
SecretArguments = "AllowedWhenTainted",
Arguments =
{
{ Name = "spellID", Type = "SpellIdentifier", Nilable = false },
},
Returns =
{
{ Name = "cooldownSpellID", Type = "number", Nilable = true },
},
},
{
Name = "GetDebuffDataByIndex",
Type = "Function",
RequiresUnitAuraAccess = true,
SecretWhenUnitAuraRestricted = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "unit", Type = "UnitTokenRestrictedForAddOns", Nilable = false },
{ Name = "index", Type = "luaIndex", Nilable = false },
{ Name = "filter", Type = "AuraFilters", Nilable = true },
},
Returns =
{
{ Name = "aura", Type = "AuraData", Nilable = true },
},
},
{
Name = "GetGroupBuffVisualAlerts",
Type = "Function",
Returns =
{
{ Name = "visualAlerts", Type = "table", InnerType = "GroupBuffVisualAlertInfo", Nilable = false },
},
},
{
Name = "GetHiddenGroupBuffs",
Type = "Function",
Returns =
{
{ Name = "spellIDs", Type = "table", InnerType = "number", Nilable = false },
},
},
{
Name = "GetPlayerAuraBySpellID",
Type = "Function",
SecretWhenUnitAuraRestricted = true,
RequiresNonSecretAura = true,
SecretArguments = "AllowedWhenTainted",
Arguments =
{
{ Name = "spellID", Type = "SpellIdentifier", Nilable = false },
},
Returns =
{
{ Name = "aura", Type = "AuraData", Nilable = true },
},
},
{
Name = "GetRefreshCarryOverDuration",
Type = "Function",
RequiresUnitAuraAccess = true,
RequiresValidUnitAuraInstance = true,
SecretWhenUnitAuraRestricted = true,
SecretArguments = "AllowedWhenTainted",
Documentation = { "Returns the client-predicted amount of time that a new spellcast of the same spell would carry over to the new application of that aura. Takes an optional spellID to use as the new duration if that cannot be derived from the aura, if that value isn't supplied the aura's spellID will be used" },
Arguments =
{
{ Name = "auraInstanceUnit", Type = "UnitToken", Nilable = false },
{ Name = "auraInstanceID", Type = "number", Nilable = false },
{ Name = "spellID", Type = "SpellIdentifier", Nilable = true },
},
Returns =
{
{ Name = "newDuration", Type = "number", Nilable = true },
},
},
{
Name = "GetRefreshExtendedDuration",
Type = "Function",
RequiresUnitAuraAccess = true,
RequiresValidUnitAuraInstance = true,
SecretWhenUnitAuraRestricted = true,
SecretArguments = "AllowedWhenTainted",
Documentation = { "Returns the client-predicted new duration of this aura if it were cast again right now. Takes an optional spellID to use as the new duration if that cannot be derived from the aura, if that value isn't supplied the aura's spellID will be used" },
Arguments =
{
{ Name = "auraInstanceUnit", Type = "UnitToken", Nilable = false },
{ Name = "auraInstanceID", Type = "number", Nilable = false },
{ Name = "spellID", Type = "SpellIdentifier", Nilable = true },
},
Returns =
{
{ Name = "newDuration", Type = "number", Nilable = true },
},
},
{
Name = "GetUnitAuraBySpellID",
Type = "Function",
SecretWhenUnitAuraRestricted = true,
RequiresNonSecretAura = true,
SecretArguments = "AllowedWhenTainted",
Documentation = { "Returns the first instance of an aura on a unit matching a given spell ID. Returns nil if no such aura is found. Additionally can return nil if querying a unit that is not visible (eg. party members on other maps)." },
Arguments =
{
{ Name = "unit", Type = "UnitTokenRestrictedForAddOns", Nilable = false, NeverSecret = true },
{ Name = "spellID", Type = "SpellIdentifier", Nilable = false },
},
Returns =
{
{ Name = "aura", Type = "AuraData", Nilable = true },
},
},
{
Name = "GetUnitAuraInstanceIDs",
Type = "Function",
RequiresUnitAuraAccess = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "unit", Type = "UnitTokenRestrictedForAddOns", Nilable = false, NeverSecret = true },
{ Name = "filter", Type = "AuraFilters", Nilable = false },
{ Name = "maxCount", Type = "number", Nilable = true },
{ Name = "sortRule", Type = "UnitAuraSortRule", Nilable = false, Default = "Unsorted" },
{ Name = "sortDirection", Type = "UnitAuraSortDirection", Nilable = false, Default = "Normal" },
},
Returns =
{
{ Name = "auraInstanceIDs", Type = "table", InnerType = "number", Nilable = false },
},
},
{
Name = "GetUnitAuras",
Type = "Function",
RequiresUnitAuraAccess = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "unit", Type = "UnitTokenRestrictedForAddOns", Nilable = false, NeverSecret = true },
{ Name = "filter", Type = "AuraFilters", Nilable = false },
{ Name = "maxCount", Type = "number", Nilable = true },
{ Name = "sortRule", Type = "UnitAuraSortRule", Nilable = false, Default = "Unsorted" },
{ Name = "sortDirection", Type = "UnitAuraSortDirection", Nilable = false, Default = "Normal" },
},
Returns =
{
{ Name = "auras", Type = "table", InnerType = "AuraData", Nilable = false, ConditionalSecretContents = true },
},
},
{
Name = "IsAuraFilteredOutByInstanceID",
Type = "Function",
RequiresUnitAuraAccess = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "unit", Type = "UnitTokenRestrictedForAddOns", Nilable = false },
{ Name = "auraInstanceID", Type = "number", Nilable = false },
{ Name = "filter", Type = "AuraFilters", Nilable = false },
},
Returns =
{
{ Name = "isFiltered", Type = "bool", Nilable = false },
},
},
{
Name = "RemoveAuraSound",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "auraSoundID", Type = "number", Nilable = false },
},
},
{
Name = "RemovePrivateAuraAnchor",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "anchorID", Type = "number", Nilable = false },
},
},
{
Name = "ResetAuraDataProvider",
Type = "Function",
},
{
Name = "SetGroupBuffVisualAlerts",
Type = "Function",
HasRestrictions = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "visualAlerts", Type = "table", InnerType = "GroupBuffVisualAlertInfo", Nilable = false, NeverSecretContents = true },
},
},
{
Name = "SetHiddenGroupBuffs",
Type = "Function",
HasRestrictions = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "spellIDs", Type = "table", InnerType = "number", Nilable = false, NeverSecretContents = true },
},
},
{
Name = "SetPrivateWarningTextAnchor",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "parent", Type = "SimpleFrame", Nilable = false },
{ Name = "anchor", Type = "AnchorBinding", Nilable = true },
},
},
{
Name = "SwitchAuraDataProvider",
Type = "Function",
},
{
Name = "WantsAlteredForm",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "unit", Type = "UnitToken", Nilable = false },
},
Returns =
{
{ Name = "wantsAlteredForm", Type = "bool", Nilable = false },
},
},
},
Events =
{
{
Name = "AuraDataProviderSwitch",
Type = "Event",
LiteralName = "AURA_DATA_PROVIDER_SWITCH",
SynchronousEvent = true,
Payload =
{
{ Name = "useRealDataProvider", Type = "bool", Nilable = false },
},
},
{
Name = "GroupBuffVisualAlertsChanged",
Type = "Event",
LiteralName = "GROUP_BUFF_VISUAL_ALERTS_CHANGED",
SynchronousEvent = true,
Payload =
{
{ Name = "visualAlerts", Type = "table", InnerType = "GroupBuffVisualAlertInfo", Nilable = false },
},
},
{
Name = "HiddenGroupBuffsChanged",
Type = "Event",
LiteralName = "HIDDEN_GROUP_BUFFS_CHANGED",
SynchronousEvent = true,
Payload =
{
{ Name = "spellIDs", Type = "table", InnerType = "number", Nilable = false },
},
},
{
Name = "UnitAura",
Type = "Event",
LiteralName = "UNIT_AURA",
SecretWhenAurasRestricted = true,
SynchronousEvent = true,
Payload =
{
{ Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false },
{ Name = "updateInfo", Type = "UnitAuraUpdateInfo", Nilable = false },
},
},
{
Name = "UnitAuraBlockListCleared",
Type = "Event",
LiteralName = "UNIT_AURA_BLOCK_LIST_CLEARED",
SynchronousEvent = true,
Payload =
{
{ Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false },
},
},
{
Name = "UnitAuraBlocked",
Type = "Event",
LiteralName = "UNIT_AURA_BLOCKED",
SynchronousEvent = true,
Payload =
{
{ Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false },
{ Name = "auraInstanceID", Type = "number", Nilable = false, SecretValue = true },
},
},
},
Tables =
{
},
Predicates =
{
},
};
APIDocumentation:AddDocumentationTable(UnitAura);