unindent definition lists
m (→Returns: English: casted -> cast) |
(unindent definition lists) |
||
| 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, isMine, isStealable = UnitBuff(unit, index or name [, castable]) | name, rank, icon, count, debuffType, duration, expirationTime, isMine, isStealable | ||
= UnitBuff(unit, index or name [, castable]) | |||
== | == 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. | |||
;castable : Boolean - If present and true (1), then only player-castable buffs will be returned; buffIndex still starts at 1. | |||
== 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 of the spell or effect that caused the buff. 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 | |||
;isMine : String - The [[unitId|unit]] that cast the buff | |||
;isStealable : Boolean - 1 if it is stealable otherwise nil | |||
== Example == | == Example == | ||