returns, fix things
m (isMine->source) |
(returns, fix things) |
||
| Line 1: | Line 1: | ||
{{wowapi}} __NOTOC__ | {{wowapi}} __NOTOC__ | ||
Retrieve info about a certain buff on a certain unit. This essentially an alias of [[API_UnitAura|UnitAura]] with the "HELPFUL" filter. | Retrieve info about a certain buff on a certain unit. This essentially an alias of [[API_UnitAura|UnitAura]] with the "HELPFUL" filter. | ||
name, rank, icon, count, debuffType, duration, expirationTime, | name, rank, icon, count, debuffType, duration, expirationTime, unitCaster, isStealable, shouldConsolidate, spellId | ||
= UnitBuff(unit, index or name [, | = UnitBuff("unit", index or ["name", "rank"][, "filter"]) | ||
== Arguments == | == Arguments == | ||
;unitId : String - The [[unitId|unit]] to query information for | ;unitId : String - The [[unitId|unit]] to query information for | ||
;index or name : Number or string - The index or name of the buff to retrieve information for. Indices start at 1 and go up indefinitely until there are no more buffs on target. | ;index or name : Number or string - The index or name of the buff to retrieve information for. Indices start at 1 and go up indefinitely until there are no more buffs on target. | ||
; | ;filter : String - zero or more of "PLAYER", "RAID", "CANCELABLE", "NOT_CANCELABLE", separated by pipe ("|") or space characters. | ||
== Returns == | == Returns == | ||
| Line 19: | Line 19: | ||
;source : String - The [[unitId|unit]] that cast the buff | ;source : String - The [[unitId|unit]] that cast the buff | ||
;isStealable : Boolean - 1 if it is stealable otherwise nil | ;isStealable : Boolean - 1 if it is stealable otherwise nil | ||
;shouldConsolidate : Boolean - 1 if the buff should be placed in a buff consolidation box (usually long-term effects). | |||
;spellId : Number - spell ID of the aura. | |||
== Example == | == Example == | ||