WoW:API UnitBuff: Difference between revisions
Jump to navigation
Jump to search
UnitBuff -Documentation by Sarf-
No edit summary |
No edit summary |
||
| Line 3: | Line 3: | ||
Retrieve info about a certain buff on a certain unit. | Retrieve info about a certain buff on a certain unit. | ||
buffTexture, buffApplications = UnitBuff(unitName, buffIndex); | buffTexture, buffApplications = UnitBuff(unitName, buffIndex, showCastable); | ||
---- | ---- | ||
| Line 24: | Line 24: | ||
:;buffIndex : The index num of the buff to retrieve info on. Starts at 1 and goes up to (and possibly beyond) a certain number. | :;buffIndex : The index num of the buff to retrieve info on. Starts at 1 and goes up to (and possibly beyond) a certain number. | ||
: The maximum numbers used by the Blizzard code are 16 for party/pet | : The maximum numbers used by the Blizzard code are 16 for party/pet and 8(?) for target buffs. | ||
:(Boolean showCastable) | |||
:;showCastable : Flag <small><i>(optional)</i></small> - Can be 0, 1, or nil. If present and 1, then only buffs will be returned which are castable by the player. Index is still starting with 1 and counting up. (new in 1.9, works in 1.9.3) | |||
---- | ---- | ||
Revision as of 13:26, 8 February 2006
Retrieve info about a certain buff on a certain unit.
buffTexture, buffApplications = UnitBuff(unitName, buffIndex, showCastable);
- Arguments
- (String unitName)
- unitName
- The name of the unit you wish to retrieve info on
- Viable names known:
- player
- party1-4
- raid1-40
- pet
- partypet1-4
- target
- (Number buffIndex)
- buffIndex
- The index num of the buff to retrieve info on. Starts at 1 and goes up to (and possibly beyond) a certain number.
- The maximum numbers used by the Blizzard code are 16 for party/pet and 8(?) for target buffs.
- (Boolean showCastable)
- showCastable
- Flag (optional) - Can be 0, 1, or nil. If present and 1, then only buffs will be returned which are castable by the player. Index is still starting with 1 and counting up. (new in 1.9, works in 1.9.3)
- Returns
- (String buffTexture)
- buffTexture
- The identifier of (path and filename to) the indicated buff, or nil if no buff
- (String buffApplications)
- buffApplications
- The number of times the buff has been applied to the target.
- Example
buff = UnitBuff("pet", i);
- Result
Retrieves the buff texture of the pets buff with the index of "i".
- Description
- Retrieve info (texture name) about a certain buff of the specified unit.
- See Also
- UnitDebuff
- Sample Code Check Hunter Aspect
- List of known buff and debuff effects that can be queried