WoW:API UnitAura: Difference between revisions
Jump to navigation
Jump to search
(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 | 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: | |||
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", | |||
== 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. | |||
Revision as of 00:19, 26 October 2008
This function was introduced in Patch 3.0. It will serve as an all-in-one solution for querying unit buffs and debuffs. UnitBuff and UnitDebuff will serve as aliases with built-in harmful/helpful filters. Usage:
name, rank, icon, count, debuffType, duration, expirationTime, isMine, isStealable = UnitAura("unit", index or ["name", "rank"][, "filter"])
Parameters
Arguments
- unit
- String - The unit you want debuff information for.
- index
- Number - The index of the debuff to retrieve info for. Starts at 1, maximum 40.
- filter
- This parameter can be any of "HELPFUL", "HARMFUL", "PLAYER", "RAID", "CANCELABLE", "NOT_CANCELABLE". You can also specify several filters separated by a space or | character to chain multiple filters together (e.g. "HELPFUL|RAID" == helpful buffs that you can cast on your raid). By default UnitAura has "HELPFUL" as an implicit filter - you cannot get back BOTH helpful and harmful at the same time. Neither "HELPFUL" or "HARMFUL" have meaning for UnitBuff/UnitDebuff, and will be ignored.
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.
- icon
- 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.
- 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.
History
- Patch 3.0 combined UnitDebuff and UnitBuff into this command.