WoW:API UnitDebuff

Revision as of 15:21, 22 May 2006 by WoWWiki>Maldivia (Added debuffDispelType return type (from 1.11))
UnitDebuff -Documentation by Sarf-

Retrieve info about a certain debuff on a certain unit.

debuffTexture, debuffApplications, debuffDispelType = UnitDebuff(unitName, debuffIndex, showDispellable);

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 debuffIndex)
debuffIndex
The index num of the debuff 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/target debuffs.
(Boolean showDispellable)
showDispellable
Flag (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
(String debuffTexture)
debuffTexture
The identifier of (path and filename to) the indicated debuff, or nil if no debuff
(String debuffApplications)
debuffApplications
The number of times the debuff has been applied to the target.
(String debuffDispelType)
debuffType
The debuff dispel type. Can be "Magic", "Curse", "Poison", "Disease" or nil if not dispellable. (Added in 1.11)

Example
debuff = UnitDebuff("pet", i);
Result

Retrieves the debuff texture of the pets debuff with the index of "i".


Description
Retrieve info (texture name) about a certain debuff of the specified unit.
See Also
UnitBuff
Why doesn't UnitDebuff accurately report the spell I just cast?
Sample Code Check Hunter's Mark Aspect
List of known buff and debuff effects that can be queried

Template:WoW API