C_UnitAuras.IsAuraFilteredOutByInstanceID

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

Flavors
war within  mainline  cata  vanilla
Links
Blizzard Docs  Townlong Yak  Offline /api  GitHub Search
Info
Added in 10.0.0 / 1.15.1

Tests if an aura passes a specific filter.

isFiltered = C_UnitAuras.IsAuraFilteredOutByInstanceID(unit, auraInstanceID, filterString)

Arguments

unit

string : UnitId - The unit to query.

auraInstanceID

number - The aura instance ID to test.

filterString

string - The aura filter string to test, eg. "HELPFUL" or "HARMFUL".

Filters

Filter	Description
"HELPFUL"	Buffs
"HARMFUL"	Debuffs
"PLAYER"	Auras Debuffs applied by the player
"RAID"	Buffs the player can apply and debuffs the player can dispell
"CANCELABLE"	Buffs that can be cancelled with /cancelaura or CancelUnitBuff()
"NOT_CANCELABLE"	Buffs that cannot be cancelled
"INCLUDE_NAME_PLATE_ONLY"	Auras that should be shown on nameplates
"MAW"	Torghast Anima Powers

Returns

isFiltered

boolean - true if the aura passes the specified filter, or false if not.

Patch changes

Patch 10.0.0 (2022-10-25): Added.