WoW:API UnitDebuff: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (wrapped the function descriptor)
Line 3: Line 3:
Retrieve info about a certain debuff on a certain unit.
Retrieve info about a certain debuff on a certain unit.


  debuffName, debuffRank, debuffTexture, debuffApplications, debuffType =
  name, rank, texture, count, debuffType, duration, timeLeft  =  UnitDebuff(unitID, debuffIndex [, removable]);
  UnitDebuff( unitID, debuffIndex [, raidFilter] );


== Parameters ==
== Parameters ==
=== Arguments ===
=== Arguments ===
 
:;unitName : String - The [[API TYPE UnitId|unit]] you want debuff information for.
:;unitName : The [[API TYPE UnitId|unit id]] you want debuff information for
:;debuffIndex : Number - The index of the debuff to retrieve info for. Starts at 1, maximum 40.
 
:;removable : Boolean - <small>''(optional)''</small> - If 1, only debuffs removable by player will be returned; debuffIndex still begins at 1.
:;debuffIndex : Number - The index of the debuff to retrieve info for. Starts at 1, maximum 40 (new in 2.0, old was 16).
 
:: The maximum numbers used by the Blizzard code are 16 for party/pet/target debuffs.  
 
:;[[raidFilter]] : Boolean - <small>''(optional)''</small> - 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 ===
=== Returns ===
 
:;name : String - The name of the spell or effect of the debuff. This is the name shown in yellow when you mouse over the icon.
:;debuffName : String - The name of the spell or effect of the debuff. This is the name shown in yellow when you mouse over the icon. (Added in 2.0)
:;rank : String - The rank of the spell or effect that caused the debuff. Returns "" if there is no rank.
 
:;texture : String - The identifier of (path and filename to) the indicated debuff, or nil if no debuff
:;debuffRank : String - The rank of the spell or effect that caused the debuff. Returns "" if there is no rank. (Added in 2.0)
:;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 ).
 
:;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 ).
 
:;debuffType : String - The type of the debuff: Magic, Disease, Poison, Curse, or nothing for those with out a type.
:;debuffType : String - The type of the debuff: Magic, Disease, Poison, Curse, or nothing for those with out a type.
:; duration : Number - The full duration of the debuff in seconds; nil if the debuff was not cast by the player.
:; timeLeft : Number - Time until the debuff expires, in seconds; nil if the deubff was not cast by the player.


== Example ==  
== Example ==  
  debuff, debuffR, debuffT = UnitDebuff("pet", i);
  name, rank, texture = UnitDebuff("pet", 1);
 
Retrieves the name, rank and icon texture of the first debuff on the player's pet.


Retrieves the texture of the player's pet's debuff along with the name and rank of the spell that caused the debuff with the index i.
== History ==
* Patch 1.9 introduced the removable argument.
* Patch 2.0 extended the debuff to 40 (from 16).
* Patch 2.0 introduced name and rank return values.
* Patch 2.1 introduced duration and timeLeft return values.


== See Also ==
== See Also ==
Line 38: Line 35:
: [[API UnitBuff|UnitBuff]]
: [[API UnitBuff|UnitBuff]]
: [[Interface Customization FAQ#Why doesn.27t UnitDebuff accurately report the spell I just cast|FAQ: Why doesn't UnitDebuff accurately report the spell I just cast?]]
: [[Interface Customization FAQ#Why doesn.27t UnitDebuff accurately report the spell I just cast|FAQ: Why doesn't UnitDebuff accurately report the spell I just cast?]]
: [[Check Hunter Mark|Sample Code Check Hunter's Mark Aspect]]
: [[HOWTO: Identify Buffs Using Textures]]
: [[Queriable Buff effects|List of known buff and debuff effects that can be queried]]
: [[Queriable Buff effects|List of known buff and debuff effects that can be queried]]

Revision as of 11:11, 30 June 2007

← WoW API < UnitDebuff

Retrieve info about a certain debuff on a certain unit. 

name, rank, texture, count, debuffType, duration, timeLeft  =  UnitDebuff(unitID, debuffIndex [, removable]);

Parameters

Arguments

unitName
String - The unit you want debuff information for.
debuffIndex
Number - The index of the debuff to retrieve info for. Starts at 1, maximum 40.
removable
Boolean - (optional) - If 1, only debuffs removable by player will be returned; debuffIndex still begins at 1.

Returns

name
String - The name of the spell or effect of the debuff. This is the name shown in yellow when you mouse over the icon.
rank
String - The rank of the spell or effect that caused the debuff. Returns "" if there is no rank.
texture
String - The identifier of (path and filename to) the indicated debuff, or nil if no debuff
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.
duration
Number - The full duration of the debuff in seconds; nil if the debuff was not cast by the player.
timeLeft
Number - Time until the debuff expires, in seconds; nil if the deubff was not cast by the player.

Example

name, rank, texture = UnitDebuff("pet", 1);

Retrieves the name, rank and icon texture of the first debuff on the player's pet.

History

  • Patch 1.9 introduced the removable argument.
  • Patch 2.0 extended the debuff to 40 (from 16).
  • Patch 2.0 introduced name and rank return values.
  • Patch 2.1 introduced duration and timeLeft return values.

See Also

UnitBuff
FAQ: Why doesn't UnitDebuff accurately report the spell I just cast?
HOWTO: Identify Buffs Using Textures
List of known buff and debuff effects that can be queried
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_UnitDebuff&oldid=7866"