WoW:API UnitBuff: Difference between revisions
Jump to navigation
Jump to search
m
Move page script moved page API UnitBuff to WoW:API UnitBuff without leaving a redirect
(link caption) |
m (Move page script moved page API UnitBuff to WoW:API UnitBuff without leaving a redirect) |
||
| (8 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
{{wowapi}} __NOTOC__ | {{wowapi}} __NOTOC__ | ||
Retrieves info about a certain buff on a certain unit. This is 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", "rank"][, "filter"]) | |||
== | == Arguments == | ||
;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. | |||
;filter : String - zero or more of "PLAYER", "RAID", "CANCELABLE", "NOT_CANCELABLE", separated by pipe ("|") or space characters. | |||
== Returns == | |||
;name : String - The name of the spell or effect of the buff, or nil if no buff was found with the specified name or at the specified index. This is the name shown in yellow when you mouse over the icon. | |||
;rank : String - The rank line from the tooltip of the spell or effect that caused the buff, e.g. "Rank 2". Returns "" if there is no rank. | |||
;iconTexture : String - The identifier of (path and filename to) the indicated buff. | |||
;count : Number - The number of times the buff has been applied to the target. | |||
;debuffType : String - The magic type of the buff | |||
;duration : Number - The full duration of the buff in seconds | |||
;expirationTime : Number - Time the buff will expire in seconds | |||
;source : String - The [[unitId|unit]] that cast the buff | |||
;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 == | ||
| Line 52: | Line 53: | ||
* Patch 2.4 (Live) has corrected the bug introduced in 2.3.2. The castable parameter correctly filters non-castable buffs once again. | * Patch 2.4 (Live) has corrected the bug introduced in 2.3.2. The castable parameter correctly filters non-castable buffs once again. | ||
* Patch 3.0 updated the return values. | * Patch 3.0 updated the return values. | ||
* Patch 3.1 changed the boolean return value isMine to the string value source. | |||
== See also == | == See also == | ||