WoW:API UnitDebuff: Difference between revisions
Jump to navigation
Jump to search
m (→Returns) |
(Clarified optional parameter. Confirmed that number is the 2nd return parameter, and it's zero for unstackable buffs.) |
||
| Line 3: | Line 3: | ||
Retrieve info about a certain debuff on a certain unit. | Retrieve info about a certain debuff on a certain unit. | ||
debuffTexture, debuffApplications, debuffDispelType = UnitDebuff(unitID, debuffIndex, showDispellable); | debuffTexture, debuffApplications, debuffDispelType = UnitDebuff( unitID, debuffIndex [, showDispellable] ); | ||
== Parameters == | == Parameters == | ||
| Line 20: | Line 20: | ||
:;debuffTexture : String - The identifier of (path and filename to) the indicated debuff, or nil if no debuff | :;debuffTexture : String - The identifier of (path and filename to) the indicated debuff, or nil if no debuff | ||
:;debuffApplications : Number | :;debuffApplications : Number - The number of times the debuff has been applied to the target. Returns 0 for any debuff which doesn't stack. ( Changed in 1.11 ). | ||
:;debuffDispelType : String - The debuff dispel type. Can be "Magic", "Curse", "Poison", "Disease" or nil if not dispellable. These strings are constant across localizations. (Added in 1.11) | :;debuffDispelType : String - The debuff dispel type. Can be "Magic", "Curse", "Poison", "Disease" or nil if not dispellable. These strings are constant across localizations. (Added in 1.11) | ||
Revision as of 21:57, 3 December 2006
← WoW API < UnitDebuff
Retrieve info about a certain debuff on a certain unit.
debuffTexture, debuffApplications, debuffDispelType = UnitDebuff( unitID, debuffIndex [, showDispellable] );
Parameters
Arguments
- unitName
- The unit id you want debuff information for
- debuffIndex
- Number - The index of the debuff to retrieve info for. Starts at 1.
- The maximum numbers used by the Blizzard code are 16 for party/pet/target debuffs.
- showDispellable
- Boolean - (optional) - Can be 0, 1, or nil. If present and 1, then only debuffs will be returned which are dispellable by the player. Index is still starting with 1 and counting up. (new in 1.9, works in 1.9.3)
Returns
- debuffTexture
- String - The identifier of (path and filename to) the indicated debuff, or nil if no debuff
- debuffApplications
- Number - The number of times the debuff has been applied to the target. Returns 0 for any debuff which doesn't stack. ( Changed in 1.11 ).
- debuffDispelType
- String - The debuff dispel type. Can be "Magic", "Curse", "Poison", "Disease" or nil if not dispellable. These strings are constant across localizations. (Added in 1.11)
Example
debuff = UnitDebuff("pet", i);
Retrieves the debuff texture of the player's pet's debuff with the index i.