WoW:API UnitDebuff: Difference between revisions
Jump to navigation
Jump to search
m (→Returns: typo fix) |
m (→Returns) |
||
| Line 22: | Line 22: | ||
:;debuffApplications : Number (docs said String?!) - The number of times the debuff has been applied to the target. Usualy returns 0 for single debuffs(Changed in 1.11). | :;debuffApplications : Number (docs said String?!) - The number of times the debuff has been applied to the target. Usualy returns 0 for single debuffs(Changed in 1.11). | ||
:;debuffDispelType : String - The debuff dispel type. Can be "Magic", "Curse", "Poison", "Disease" or nil if not dispellable. (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) | ||
== Example == | == Example == | ||
debuff = UnitDebuff("pet", i); | debuff = UnitDebuff("pet", i); | ||
Retrieves the debuff texture of the | Retrieves the debuff texture of the player's pet's debuff with the index i. | ||
== See Also == | == See Also == | ||
Revision as of 21:36, 24 October 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 (docs said String?!) - The number of times the debuff has been applied to the target. Usualy returns 0 for single debuffs(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.