C_UnitAuras
namespaceavailable in: camelotStatus in wowlua
39 functions: 9 implemented, 1 recorded, 29 guessed. 6 events, 3 of them fired by the emulator on its own.
Functions
| function | what it does | status |
|---|---|---|
AddAuraSound | 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.(trigger: UnitAuraSoundTrigger, sound: UnitAuraSoundInfo): number? | guessed |
AddBlockedAura | Blocks the aura on the unit from being shown. · by wowlua(unit: UnitTokenRestrictedForAddOns, auraInstanceID: number) | guessed |
AddPrivateAuraAnchor | Adds an anchor where private auras of a unit are shown; returns the anchor ID. · by wowlua(args: AddPrivateAuraAnchorArgs): number? | guessed |
AuraIsBigDefensive | Whether the aura is a major defensive effect. · by wowlua(spellID: SpellIdentifier): boolean | guessed |
AuraIsPrivate | Whether the aura is a private aura, which addons cannot see. · by wowlua(spellID: SpellIdentifier): boolean | guessed |
CancelAuraByInstanceID | Cancels the aura on the unit. · by wowlua(unit: UnitTokenRestrictedForAddOns, auraInstanceID: number) | guessed |
ClearBlockedAuras | Clears the list of blocked auras on the unit. · by wowlua(unit: UnitTokenRestrictedForAddOns) | guessed |
DoesAuraHaveExpirationTime | Returns true if an aura instance will expire after a certain amount of time.(auraInstanceUnit: string, auraInstanceID: number): boolean | guessed |
GetAuraApplicationDisplayCount | Formats a string for displaying the number of applications an aura has present.(auraInstanceUnit: string, auraInstanceID: number, minDisplayCount: number, maxDisplayCount: number?): string | guessed |
GetAuraBaseDuration | 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(auraInstanceUnit: string, auraInstanceID: number, spellID: SpellIdentifier?): number? | guessed |
GetAuraCasterGUID | Returns the GUID of the aura's caster. · by wowlua(auraInstanceUnit: string, auraInstanceID: number): string? | guessed |
GetAuraDataByAuraInstanceID | Returns information about an aura on a unit by a given aura instance ID.(unit: UnitTokenRestrictedForAddOns, auraInstanceID: number): AuraData? | implemented |
GetAuraDataByIndex | Returns the aura on the unit at the given index. · by wowlua(unit: UnitTokenRestrictedForAddOns, index: number, filter: AuraFilters?): AuraData? | implemented |
GetAuraDataBySlot | Returns information about an aura on a unit by a given slot index.(unit: UnitTokenRestrictedForAddOns, slot: number): AuraData? | implemented |
GetAuraDataBySpellName | Returns the aura on the unit with the given spell name. · by wowlua(unit: UnitTokenRestrictedForAddOns, spellName: string, filter: AuraFilters?): AuraData? | implemented |
GetAuraDispelTypeColor | 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.(auraInstanceUnit: string, auraInstanceID: number, curve: LuaColorCurveObject): ColorMixin | guessed |
GetAuraDuration | Returns a duration object for the aura, running from its start to its expiration. · by wowlua(auraInstanceUnit: string, auraInstanceID: number): LuaDurationObject | guessed |
GetAuraSlots | Returns a continuation token, then the slots of the unit's auras that pass the filter; pass the token back to get the next slots. · by wowlua(unit: UnitTokenRestrictedForAddOns, filter: AuraFilters?, maxSlots: number?, continuationToken: number?): (number?, number) | implemented |
GetBuffDataByIndex | Returns the helpful aura on the unit at the given index. · by wowlua(unit: UnitTokenRestrictedForAddOns, index: number, filter: AuraFilters?): AuraData? | implemented |
GetCooldownAuraBySpellID | Obtains the spell ID of a passive cooldown effect associated with a spell.(spellID: SpellIdentifier): number? | guessed |
GetDebuffDataByIndex | Returns the harmful aura on the unit at the given index. · by wowlua(unit: UnitTokenRestrictedForAddOns, index: number, filter: AuraFilters?): AuraData? | implemented |
GetGroupBuffVisualAlerts | Returns the alerts passed to SetGroupBuffVisualAlerts plus an entry for every linked rank spell of those group buffs.(): GroupBuffVisualAlertInfo[] | recorded |
GetHiddenGroupBuffs | Returns the spell IDs passed to SetHiddenGroupBuffs plus every linked rank spell of those group buffs.(): number[] | implemented |
GetPlayerAuraBySpellID | Returns information about an aura on the player by a given spell ID.(spellID: SpellIdentifier): AuraData? | implemented |
GetRefreshCarryOverDuration | 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(auraInstanceUnit: string, auraInstanceID: number, spellID: SpellIdentifier?): number? | guessed |
GetRefreshExtendedDuration | 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(auraInstanceUnit: string, auraInstanceID: number, spellID: SpellIdentifier?): number? | guessed |
GetUnitAuraBySpellID | 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).(unit: UnitTokenRestrictedForAddOns, spellID: SpellIdentifier): AuraData? | guessed |
GetUnitAuraInstanceIDs | Returns the instance IDs of the unit's auras that pass the filter. · by wowlua(unit: UnitTokenRestrictedForAddOns, filter: AuraFilters, maxCount: number?, sortRule: UnitAuraSortRule, sortDirection: UnitAuraSortDirection): number[] | guessed |
GetUnitAuras | Returns the unit's auras that pass the filter. · by wowlua(unit: UnitTokenRestrictedForAddOns, filter: AuraFilters, maxCount: number?, sortRule: UnitAuraSortRule, sortDirection: UnitAuraSortDirection): AuraData[] | guessed |
IsAuraFilteredOutByInstanceID | Tests if an aura passes a specific filter.(unit: UnitTokenRestrictedForAddOns, auraInstanceID: number, filter: AuraFilters): boolean | guessed |
RemoveAuraSound | Removes an aura sound registered with C_UnitAuras.AddAuraSound. · by wowlua(auraSoundID: number) | guessed |
RemovePrivateAuraAnchor | Removes a private aura anchor added with C_UnitAuras.AddPrivateAuraAnchor. · by wowlua(anchorID: number) | guessed |
RemovePrivateAuraAppliedSound | Removes a sound that plays when a private aura is applied. · by wowluanot in Blizzard's documentation | guessed |
ResetAuraDataProvider | Resets the aura data provider to its default. · by wowlua() | guessed |
SetGroupBuffVisualAlerts | Sets the visual alerts shown for missing group buffs. · by wowlua(visualAlerts: GroupBuffVisualAlertInfo[]) | guessed |
SetHiddenGroupBuffs | Sets which group buffs are hidden. · by wowlua(spellIDs: number[]) | guessed |
SetPrivateWarningTextAnchor | Anchors the private aura warning text to a frame. · by wowlua(parent: Frame, anchor: AnchorBinding?) | guessed |
SwitchAuraDataProvider | Switches to the other aura data provider. · by wowlua() | guessed |
WantsAlteredForm | Whether the unit wants to be shown in its altered form. · by wowlua(unit: string): boolean | guessed |
"by wowlua": no one documents this function, so wowlua wrote the description from its name, signature and behaviour.
Events
| event | payload | fired by the emulator |
|---|---|---|
AURA_DATA_PROVIDER_SWITCH | useRealDataProvider: boolean | not implemented |
GROUP_BUFF_VISUAL_ALERTS_CHANGED | visualAlerts: GroupBuffVisualAlertInfo[] | implemented |
HIDDEN_GROUP_BUFFS_CHANGED | spellIDs: number[] | implemented |
UNIT_AURA | unitTarget: string, updateInfo: UnitAuraUpdateInfo | implemented |
UNIT_AURA_BLOCKED | unitTarget: string, auraInstanceID: number | not implemented |
UNIT_AURA_BLOCK_LIST_CLEARED | unitTarget: string | not implemented |
An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("AURA_DATA_PROVIDER_SWITCH").
sources
Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (UnitAuras system, camelot 1.60.1). Descriptions: Blizzard's API documentation (Blizzard_APIDocumentationGenerated); warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.