API UnitDebuff

From Wowpedia
Jump to: navigation, search

Retrieve info about a certain buff on a certain unit.

name, icon, count, debuffType, duration, expirationTime, source, isStealable, 
  nameplateShowPersonal, spellId, canApplyAura, isBossDebuff, castByPlayer, nameplateShowAll, timeMod, ...
= UnitBuff("unit", index[, "filter"])

Arguments

unit 
String (unitId) - unit whose buffs to query.
index 
Number or String - index (from 1 to 40)
filter 
String (optional) - list of filters, separated by spaces or pipes ("|"). "HELPFUL" by default. The following filters are available:
HELPFUL - buffs.
HARMFUL - debuffs.
PLAYER - debuffs that were applied by the player.
RAID - debuffs that can be applied by the player.
CANCELABLE - debuffs that can be removed (such as by right-clicking or using the /cancelaura command)
NOT_CANCELABLE - debuffs that cannot be removed


Returns

1. 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 buff's icon.
2. icon 
Number (fileID) - identifier of the texture used for the buff's icon.
3. count 
Number - The number of times the buff has been applied to the target.
4. debuffType 
String - The magic type of the buff
5. duration 
Number - The full duration of the buff in seconds
6. expirationTime 
Number - Time the buff expires (compare to GetTime())
7. source 
String - The unit that cast the buff
8. isStealable 
Boolean - true if it is stealable
9. nameplateShowPersonal 
Boolean - true if the buff should be shown on the player/pet/vehicle nameplate
10. spellId 
Number - spell ID of the aura.
11. canApplyAura 
Boolean - true if the player can apply the aura (not necessarily if the player did apply the aura, just if the player can apply the aura).
12. isBossDebuff 
Boolean - true if the aura was cast by a boss.
13. castByPlayer 
Boolean - true if the aura was applied by a player.
14. nameplateShowAll 
Boolean - true if the buff should be shown on nameplates
15. timeMod 
Number - scaling factor used for displaying time left
16 and subsequent. ... 
Additional values, documented as up to 11 but possibly more, based on the specifics of the aura in question.

Example

The following snippet prints the name, icon, and time left for each debuff on the player:

for i=1,40 do
  local name, icon, _, _, _, etime = UnitDebuff("player",i)
  if name then
    print(("%d=%s, %s, %.2f minutes left."):format(i,name,icon,(etime-GetTime())/60))
  end
end

Notes

  • This is essentially an alias of UnitAura with the "HARMFUL" filter applied.
  • UnitDebuff and other UnitAura-based queries may not be accurate immediately after casting a spells that applies an aura to its target.

Patch changes

  • Battle for Azeroth Patch 8.0.1 (2018-07-17): Removed Rank and querying by name
  • Legion Patch 7.0.3 (2016-07-19): Added return values "nameplateShowAll" and "timeMod"; changed "shouldConsolidate" to "nameplateShowPersonal".
  • Cataclysm Patch 4.2.0 (2011-06-28): Re-added the return values "canApplyAura" and "isBossDebuff" and added return values value[1-3].
  • Cataclysm Patch 4.0.1 (2010-10-12): Removed the return values "canApplyAura" and "isBossDebuff".
  • Wrath of the Lich King Patch 3.3.0 (2009-12-08): Added shouldConsolidate and spellId.
  • Wrath of the Lich King Patch 3.1.0 (2009-04-14): Changed "isMine" to "unitCaster". It is now possible for addons to retrieve the unitId that cast the buff/debuff.
  • Wrath of the Lich King Patch 3.0.2 (2008-10-14): Changed this into an alias of UnitAura; durations are now available for all debuffs.
  • The Burning Crusade Patch 2.1.0 (2007-05-22): Introduced duration and timeLeft return values.
  • The Burning Crusade Patch 2.0.1 (2006-12-05): Introduced name and rank return values and extended the maximum number of debuffs to 40 (from 16).
  • WoW Icon update.png Patch 1.9.0 (2006-01-03): Introduced the removable argument.

See also