WoW:API UnitDebuff: Difference between revisions

WoW:API UnitDebuff (source)

Revision as of 13:34, 15 December 2009

195 bytes added , 15 December 2009

3.3 update

Anonymous user

WoWWiki>Starlightblunder

@@ Line 1: / Line 1: @@
 {{wowapi}} __NOTOC__
 Retrieve info about a certain debuff on a certain unit. This is essentially an alias of [[API_UnitAura|UnitAura]] with the "HARMFUL" filter applied.
+ name, rank, icon, count, debuffType, duration, expirationTime, unitCaster, isStealable, shouldConsolidate, spellId
+  = UnitDebuff("unit", index or ["name", "rank"][, "filter"])
- name, rank, icon, count, debuffType, duration, expirationTime, unitCaster, isStealable  =  UnitDebuff(unitID, index or name [, removable]);
+== Arguments ==
+;unitId : String - The [[API TYPE UnitId|unit]] you want debuff information for.
+;index or name : Number or string - The index or name of the debuff to retrieve information for. Indices range from 1 to 40.
+;removable : Boolean - <small>''(optional)''</small> - If 1, only debuffs removable by player will be returned; debuffIndex still begins at 1.
-== Parameters ==
+== Returns ==
-=== Arguments ===
+;name : String - The name of the spell or effect of the debuff, or nil if no debuff was found with the specified name or at the specified index. This is the name shown in yellow when you mouse over the icon.
-:;unitId : String - The [[API TYPE UnitId|unit]] you want debuff information for.
+;rank : String - The rank of the spell or effect that caused the debuff. Returns "" if there is no rank.
-:;index or name : Number or string - The index or name of the debuff to retrieve information for. Indices range from 1 to 40.
+;icon : String - The identifier of (path and filename to) the indicated debuff, or nil if no debuff
-:;removable : Boolean - <small>''(optional)''</small> - If 1, only debuffs removable by player will be returned; debuffIndex still begins at 1.
+;count : 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 ).
+;debuffType : String - The type of the debuff: Magic, Disease, Poison, Curse, or nothing for those with out a type.
-=== Returns ===
+; duration : Number - The full duration of the debuff in seconds; nil if the debuff was not cast by the player.
-:;name : String - The name of the spell or effect of the debuff, or nil if no debuff was found with the specified name or at the specified index. This is the name shown in yellow when you mouse over the icon.
+; expirationTime : Number - Time at which the debuff expires (GetTime() as a reference frame).
-:;rank : String - The rank of the spell or effect that caused the debuff. Returns "" if there is no rank.
+; unitCaster : String - [[unitId]] reference to the unit that casted the buff/debuff.
-:;icon : String - The identifier of (path and filename to) the indicated debuff, or nil if no debuff
+;isStealable : Boolean - 1 if it is stealable otherwise nil
-:;count : 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 ).
+;shouldConsolidate : Boolean - 1 if the buff should be placed in a buff consolidation box (usually long-term effects).
-:;debuffType : String - The type of the debuff: Magic, Disease, Poison, Curse, or nothing for those with out a type.
+;spellId : Number - spell ID of the aura.
-:; duration : Number - The full duration of the debuff in seconds; nil if the debuff was not cast by the player.
-:; expirationTime : Number - Time at which the debuff expires (GetTime() as a reference frame).
-:; unitCaster : String - [[unitId]] reference to the unit that casted the buff/debuff.
-:; isStealable : 1 or nil - ?
 == Example ==
 Retrieves the name, rank and icon texture of the first debuff on the player's pet:
   name, rank, texture = UnitDebuff("pet", 1);
 == Macros ==