WoW:API UnitAura - Revision history

Move page script: Move page script moved page API UnitAura to WoW:API UnitAura without leaving a redirect

2023-08-15T04:47:42Z

Move page script moved page API UnitAura to API UnitAura without leaving a redirect

← Older revision

Revision as of 04:47, 15 August 2023

WoWWiki>Jaycyn: /* Returns */

2011-12-08T23:20:35Z

Returns

← Older revision		Revision as of 23:20, 8 December 2011
Line 29:		Line 29:
	;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.		;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.		;rank : String - The rank of the spell or effect that caused the debuff. Returns "" if there is no rank.
	;icon		;icon : String - The path to the icon file.
	;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 ).		;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.		;debuffType : String - The type of the debuff: Magic, Disease, Poison, Curse, or nothing for those with out a type.

WoWWiki>Kitjan: Expanded on the two flavors of UnitAura (name vs index)

2010-07-12T19:03:20Z

Expanded on the two flavors of UnitAura (name vs index)

← Older revision		Revision as of 19:03, 12 July 2010
Line 7:		Line 7:
	= UnitAura("unit", index or "name"[, "rank"[, "filter"]])		= UnitAura("unit", index or "name"[, "rank"[, "filter"]])

	Either use:		If the second parameter is a string, then the third parameter is the rank (which can be nil)
	'''unit''', '''index'''~~/'''name''' and~~ '''filter'''		<dl>
	or		<dt>Either use:
	'''unit''', '''~~index~~'''/'''~~name~~''', '''~~rank~~''' ~~and~~ '''~~filter~~'''.		<dd>'''unit''', '''index''', '''filter'''
			<dt>or
			<dd>'''unit''', '''name''', '''rank''', '''filter'''</dl>

			'''Examples''':<ul>
			<li>UnitAura("target", 1) -- First buff on target
			<li>UnitAura("target", 1, "PLAYER\|HARMFUL") -- First debuff, cast by the player, on the target
			<li>UnitAura("player", "Lightning Shield") -- first instance of "Lightning Shield" on the player
			<li>UnitAura("player", "Lightning Shield", nil, "PLAYER\|HELPFUL") -- first instance of "Lightning Shield" on the player, cast by the player
			<li>UnitAura("player", "Lightning Shield", "Rank 2") -- first instance of "Lightning Shield", rank 2, on the player</ul>

	== Arguments ==		== Arguments ==

WoWWiki>ShandrisForever: clarif.

2010-07-12T18:16:21Z

clarif.

← Older revision		Revision as of 18:16, 12 July 2010
Line 2:		Line 2:

	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.		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:
			'''''Usage''''':
	name, rank, icon, count, debuffType, duration, expirationTime, unitCaster, isStealable, shouldConsolidate, spellId		name, rank, icon, count, debuffType, duration, expirationTime, unitCaster, isStealable, shouldConsolidate, spellId
	= UnitAura("unit", index or "name"[, "rank"[, "filter"]])		= UnitAura("unit", index or "name"[, "rank"[, "filter"]])

			Either use:
			'''unit''', '''index'''/'''name''' and '''filter'''
			or
			'''unit''', '''index'''/'''name''', '''rank''' and '''filter'''.

	== Arguments ==		== Arguments ==

WoWWiki>Hati~: Fixed an typo in usage - wasn't clearly if name & rank have to be together

2010-02-20T19:04:53Z

Fixed an typo in usage - wasn't clearly if name & rank have to be together

← Older revision		Revision as of 19:04, 20 February 2010
Line 4:		Line 4:
	Usage:		Usage:
	name, rank, icon, count, debuffType, duration, expirationTime, unitCaster, isStealable, shouldConsolidate, spellId		name, rank, icon, count, debuffType, duration, expirationTime, unitCaster, isStealable, shouldConsolidate, spellId
	= UnitAura("unit", index or ["name", "rank"][, "filter"])		= UnitAura("unit", index or "name"[, "rank"[, "filter"]])

	== Arguments ==		== Arguments ==

WoWWiki>Kitjan: /* History Added 3.3 returns */

2009-12-09T02:03:11Z

History Added 3.3 returns

← Older revision		Revision as of 02:03, 9 December 2009
Line 3:		Line 3:
	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.		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:		Usage:
	name, rank, icon, count, debuffType, duration, expirationTime, unitCaster, isStealable		name, rank, icon, count, debuffType, duration, expirationTime, unitCaster, isStealable, shouldConsolidate, spellId
	= UnitAura("unit", index or ["name", "rank"][, "filter"])		= UnitAura("unit", index or ["name", "rank"][, "filter"])

Line 21:		Line 21:
	; unitCaster : String - [[unitId]] reference to the unit that casted the buff/debuff.		; unitCaster : String - [[unitId]] reference to the unit that casted the buff/debuff.
	; isStealable : Boolean - 1 or nil depending on if the aura can be spellstolen.		; isStealable : Boolean - 1 or nil depending on if the aura can be spellstolen.
			; shouldConsolidate : Boolean - 1 or nil depending on if the default Blizzard UI should put the aura into the "consolidated" box of buffs.
			; spellId : Number - the spellId of the aura.

	==Macro Options:==		==Macro Options:==
Line 31:		Line 32:
	* Patch 3.0 combined UnitDebuff and UnitBuff into this command.		* Patch 3.0 combined UnitDebuff and UnitBuff into this command.
	* Patch 3.1 changed "isMine" to "unitCaster". It is now possible for addons to retrieve the unitId that cast the buff/debuff.		* Patch 3.1 changed "isMine" to "unitCaster". It is now possible for addons to retrieve the unitId that cast the buff/debuff.
			* Patch 3.3 added shouldConsolidate and spellId

	== See Also ==		== See Also ==

WoWWiki>Archarodim: expirationTime is always returned regardless of who cast the buff/debuff

2009-08-22T09:45:21Z

expirationTime is always returned regardless of who cast the buff/debuff

← Older revision		Revision as of 09:45, 22 August 2009
Line 17:		Line 17:
	;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 ).		;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.		;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;
	; expirationTime : Number - ~~Time~~ in seconds when the aura will expire.		; expirationTime : Number - The time in seconds (like what returns [[API GetTime\|GetTime()]]) when the aura will expire.
	; unitCaster : String - [[unitId]] reference to the unit that casted the buff/debuff.		; unitCaster : String - [[unitId]] reference to the unit that casted the buff/debuff.
	; isStealable : Boolean - 1 or nil depending on if the aura can be spellstolen.		; isStealable : Boolean - 1 or nil depending on if the aura can be spellstolen.

WoWWiki>Starlightblunder: wrap signature; remove Parameters header; unindent lists

2009-05-28T13:10:34Z

wrap signature; remove Parameters header; unindent lists

← Older revision		Revision as of 13:10, 28 May 2009
Line 3:		Line 3:
	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.		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:		Usage:
	name, rank, icon, count, debuffType, duration, expirationTime, unitCaster, isStealable = UnitAura("unit", index or ["name", "rank"][, "filter"])		name, rank, icon, count, debuffType, duration, expirationTime, unitCaster, isStealable
			= UnitAura("unit", index or ["name", "rank"][, "filter"])

	~~== Parameters ==~~		== Arguments ==
	=== Arguments ===		;unit : String - The [[API TYPE UnitId\|unit]] you want debuff information for.
	:;unit : String - The [[API TYPE UnitId\|unit]] you want debuff information for.		;index : Number - The index of the debuff to retrieve info for. Starts at 1, maximum 40.
	:;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 \| or space character to chain multiple filters together (e.g. "HELPFUL\|RAID" or "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.
	:;filter : This parameter can be any of "HELPFUL", "HARMFUL", "PLAYER", "RAID", "CANCELABLE", "NOT_CANCELABLE". You can also specify several filters separated by a \| or space character to chain multiple filters together (e.g. "HELPFUL\|RAID" or "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 ===		== 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.		;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.		;rank : String - The rank of the spell or effect that caused the debuff. Returns "" if there is no rank.
	:;icon		;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 ).		;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.		;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.		; expirationTime : Number - Time in seconds when the aura will expire.
	:; unitCaster : String - [[unitId]] reference to the unit that casted the buff/debuff.		; unitCaster : String - [[unitId]] reference to the unit that casted the buff/debuff.
	:; isStealable : Boolean - 1 or nil depending on if the aura can be spellstolen.		; isStealable : Boolean - 1 or nil depending on if the aura can be spellstolen.

WoWWiki>Niightblade: /* History */ English: casted -> cast

2009-05-09T07:36:02Z

History: English: casted -> cast

← Older revision		Revision as of 07:36, 9 May 2009
Line 30:		Line 30:
	== History ==		== History ==
	* Patch 3.0 combined UnitDebuff and UnitBuff into this command.		* Patch 3.0 combined UnitDebuff and UnitBuff into this command.
	* Patch 3.1 changed "isMine" to "unitCaster". It is now possible for addons to retrieve the unitId that ~~casted~~ the buff/debuff.		* Patch 3.1 changed "isMine" to "unitCaster". It is now possible for addons to retrieve the unitId that cast the buff/debuff.

	== See Also ==		== See Also ==

WoWWiki>Jeffrey0: 3.1 update; changed isMine to unitCaster.

2009-04-15T01:44:10Z

3.1 update; changed isMine to unitCaster.

← Older revision		Revision as of 01:44, 15 April 2009
Line 3:		Line 3:
	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.		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:		Usage:
	name, rank, icon, count, debuffType, duration, expirationTime, ~~isMine~~, isStealable = UnitAura("unit", index or ["name", "rank"][, "filter"])		name, rank, icon, count, debuffType, duration, expirationTime, unitCaster, isStealable = UnitAura("unit", index or ["name", "rank"][, "filter"])

	== Parameters ==		== Parameters ==
Line 19:		Line 19:
	:; 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.		:; expirationTime : Number - Time in seconds when the aura will expire.
	:; ~~isMine~~ : ~~Boolean~~ - ~~1 or nil if~~ the ~~aura was~~ casted by the ~~player~~.		:; unitCaster : String - [[unitId]] reference to the unit that casted the buff/debuff.
	:; isStealable : Boolean - 1 or nil if the aura ~~was casted by the player~~.		:; isStealable : Boolean - 1 or nil depending on if the aura can be spellstolen.


Line 30:		Line 30:
	== History ==		== History ==
	* Patch 3.0 combined UnitDebuff and UnitBuff into this command.		* Patch 3.0 combined UnitDebuff and UnitBuff into this command.
			* Patch 3.1 changed "isMine" to "unitCaster". It is now possible for addons to retrieve the unitId that casted the buff/debuff.

	== See Also ==		== See Also ==