WoW:API UnitAura: Difference between revisions

Tidied up and completed return values
(initial information, based on the previous function and Iriel's preview)
 
(Tidied up and completed return values)
Line 1: Line 1:
{{wowapi}} __NOTOC__
{{wowapi}} __NOTOC__


This function will be introduced in Patch 3.0. It will serve as an all-in-one solution for querying unit buffs and debuffs. [[API UnitBuff|UnitBuff]] and [[API UnitDebuff|UnitDebuff]] will serve as aliases with built-in harmful/helpful filters.
This function was introduced in Patch 3.0. It will serve as an all-in-one solution for querying unit buffs and debuffs. [[API UnitBuff|UnitBuff]] and [[API UnitDebuff|UnitDebuff]] will serve as aliases with built-in harmful/helpful filters.
 
Usage:
The new parameters and return values are:
name, rank, icon, count, debuffType, duration, expirationTime, isMine, isStealable = UnitAura("unit", index or ["name", "rank"][, "filter"])  
name, rank, icon, count, debuffType, duration, expirationTime, isMine, isStealable = UnitAura("unit", [index] or ["name", "rank"][, "filter"])  
 


== Parameters ==
== Parameters ==
Line 20: Line 18:
:;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.
:; duration : Number - The full duration of the debuff in seconds; nil if the debuff was not cast by the player.
:; expirationTime : Number - Time in seconds when the aura will expire.
:; isMine : Boolean - 1 or nil if the aura was casted by the player.
:; isStealable : Boolean - 1 or nil if the aura was casted by the player.




Anonymous user