WoW:API UnitDebuff - Revision history

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

2023-08-15T04:47:43Z

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

← Older revision	Revision as of 04:47, 15 August 2023
(No difference)

WoWWiki>Niightblade: spelling: casted -> cast

2010-01-18T04:22:44Z

spelling: casted -> cast

← Older revision		Revision as of 04:22, 18 January 2010
Line 17:		Line 17:
	; 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 at which the debuff expires (GetTime() as a reference frame).		; 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.		; unitCaster : String - [[unitId]] reference to the unit that cast the buff/debuff.
	;isStealable : Boolean - 1 if it is stealable otherwise nil		;isStealable : Boolean - 1 if it is stealable otherwise nil
	;shouldConsolidate : Boolean - 1 if the buff should be placed in a buff consolidation box (usually long-term effects).		;shouldConsolidate : Boolean - 1 if the buff should be placed in a buff consolidation box (usually long-term effects).
Line 39:		Line 39:
	* Patch 2.1 introduced duration and timeLeft return values.		* Patch 2.1 introduced duration and timeLeft return values.
	* Patch 3.0 changes this into an alias of UnitAura; durations are now available for all debuffs.		* Patch 3.0 changes this into an alias of UnitAura; durations are now available for all debuffs.
	* 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>Starlightblunder: 3.3 update

2009-12-15T13:34:37Z

3.3 update

← Older revision		Revision as of 13:34, 15 December 2009
Line 1:		Line 1:
	{{wowapi}} __NOTOC__		{{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.		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 ==		== Example ==
	Retrieves the name, rank and icon texture of the first debuff on the player's pet:		Retrieves the name, rank and icon texture of the first debuff on the player's pet:
	name, rank, texture = UnitDebuff("pet", 1);		name, rank, texture = UnitDebuff("pet", 1);


	== Macros ==		== Macros ==

WoWWiki>Tkenji: Fixed "isMine" into "unitCaster", added in 3.1. This change was actually in UnitAura. Changed here also because it is just an alias for UnitAura.

2009-04-16T11:13:19Z

Fixed "isMine" into "unitCaster", added in 3.1. This change was actually in UnitAura. Changed here also because it is just an alias for UnitAura.

← Older revision		Revision as of 11:13, 16 April 2009
Line 3:		Line 3:
	Retrieve info about a certain debuff on a certain unit. This is essentially an alias of [[API_UnitAura\|UnitAura]] with the "HARMFUL" filter applied.		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, ~~isMine~~, isStealable = UnitDebuff(unitID, index or name [, removable]);		name, rank, icon, count, debuffType, duration, expirationTime, unitCaster, isStealable = UnitDebuff(unitID, index or name [, removable]);

	== 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 at which the debuff expires (GetTime() as a reference frame).		:; expirationTime : Number - Time at which the debuff expires (GetTime() as a reference frame).
	:; ~~isMine~~ : ~~1 or nil~~ - ~~1 if this~~ debuff ~~was applied by the player~~.		:; unitCaster : String - [[unitId]] reference to the unit that casted the buff/debuff.
	:; isStealable : 1 or nil - ?		:; isStealable : 1 or nil - ?

Line 40:		Line 40:
	* Patch 2.1 introduced duration and timeLeft return values.		* Patch 2.1 introduced duration and timeLeft return values.
	* Patch 3.0 changes this into an alias of UnitAura; durations are now available for all debuffs.		* Patch 3.0 changes this into an alias of UnitAura; durations are now available for all debuffs.
			* 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 ==

WoWWiki>Starlightblunder: remove faq link

2009-04-07T00:05:01Z

remove faq link

← Older revision		Revision as of 00:05, 7 April 2009
Line 1:		Line 1:
	{{wowapi}} __NOTOC__		{{wowapi}} __NOTOC__

	Retrieve info about a certain debuff on a certain unit.		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, ~~iconTexture~~, count, debuffType, duration, ~~timeLeft~~ = UnitDebuff(unitID, index or name [, removable]);		name, rank, icon, count, debuffType, duration, expirationTime, isMine, isStealable = UnitDebuff(unitID, index or name [, removable]);

	== Parameters ==		== Parameters ==
Line 14:		Line 14:
	:;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.		:;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.
	:;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.
	:;~~texture~~ : String - The identifier of (path and filename to) the indicated debuff, or nil if no debuff		:;icon : 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 ).		:;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.
	:; ~~timeLeft~~ : Number - Time ~~until~~ the debuff expires~~, 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).
			:; isMine : 1 or nil - 1 if this debuff was applied by the player.
			:; isStealable : 1 or nil - ?

	== Example ==		== Example ==
	Retrieves the name, rank and icon texture of the first debuff on the player's pet:		Retrieves the name, rank and icon texture of the first debuff on the player's pet:
	~~<pre>~~name, rank, texture = UnitDebuff("pet", 1);~~</pre>~~		name, rank, texture = UnitDebuff("pet", 1);


	== Macros ==		== Macros ==
	Macro to print a list of the target's debuffs:		Macro to print a list of the target's debuffs:
	~~<pre>~~/run for i=1,40 do local D= UnitDebuff("target",i); if D then print(i.."="..D) end end~~</pre>~~		/run for i=1,40 do local D= UnitDebuff("target",i); if D then print(i.."="..D) end end
	~~<br>~~
	~~Macro to retrieve focus's remaining debuff time for any of the three Mage Poly spells and announce it via "SAY":~~
	<pre>/run for i=1,40 do local n,_,_,_,_,_,x,_,_=UnitDebuff("focus",i);if (n=="Polymorph")or (n=="Polymorph(Pig)")or (n=="Polymorph(Turtle)")then SendChatMessage(format("%.0f",-1*(GetTime()-x)).." secs left on "..UnitName("focus").."'s CC!","EMOTE");end end
	~~</pre>~~

			== Notes ==
			* UnitDebuff and other UnitAura-based queries may not be accurate immediately after casting a spells that applies an aura to its target.

	== History ==		== History ==
Line 39:		Line 39:
	* Patch 2.0 introduced name and rank return values.		* Patch 2.0 introduced name and rank return values.
	* Patch 2.1 introduced duration and timeLeft return values.		* Patch 2.1 introduced duration and timeLeft return values.
			* Patch 3.0 changes this into an alias of UnitAura; durations are now available for all debuffs.

	== See Also ==		== See Also ==
			: [[API_UnitAura\|UnitAura]], [[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?~~]]
	: [[HOWTO: Identify Buffs Using Textures]]		: [[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]]

WoWWiki>Valana at 16:17, 10 November 2008

2008-11-10T16:17:43Z

← Older revision		Revision as of 16:17, 10 November 2008
Line 3:		Line 3:
	Retrieve info about a certain debuff on a certain unit.		Retrieve info about a certain debuff on a certain unit.

	name, rank, iconTexture, count, debuffType, duration, timeLeft = UnitDebuff(unitID, ~~debuffIndex~~ [, removable]);		name, rank, iconTexture, count, debuffType, duration, timeLeft = UnitDebuff(unitID, index or name [, removable]);

	== Parameters ==		== Parameters ==
	=== Arguments ===		=== Arguments ===
	:;unitId : String - The [[API TYPE UnitId\|unit]] you want debuff information for.		:;unitId : String - The [[API TYPE UnitId\|unit]] you want debuff information for.
	:;~~debuffIndex~~ : Number - The index of the debuff to retrieve ~~info~~ for. ~~Starts at~~ 1~~, maximum~~ 40.		:;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.		:;removable : Boolean - <small>''(optional)''</small> - If 1, only debuffs removable by player will be returned; debuffIndex still begins at 1.

	=== 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, 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.
	:;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.
	:;texture : String - The identifier of (path and filename to) the indicated debuff, or nil if no debuff		:;texture : String - The identifier of (path and filename to) the indicated debuff, or nil if no debuff

WoWWiki>Belleboom at 22:18, 19 October 2008

2008-10-19T22:18:49Z

← Older revision		Revision as of 22:18, 19 October 2008
Line 21:		Line 21:

	== Example ==		== Example ==
	name, rank, texture = UnitDebuff("pet", 1);		Retrieves the name, rank and icon texture of the first debuff on the player's pet:
			<pre>name, rank, texture = UnitDebuff("pet", 1);</pre>

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

			== Macros ==
			Macro to print a list of the target's debuffs:
			<pre>/run for i=1,40 do local D= UnitDebuff("target",i); if D then print(i.."="..D) end end</pre>
			<br>
			Macro to retrieve focus's remaining debuff time for any of the three Mage Poly spells and announce it via "SAY":
			<pre>/run for i=1,40 do local n,_,_,_,_,_,x,_,_=UnitDebuff("focus",i);if (n=="Polymorph")or (n=="Polymorph(Pig)")or (n=="Polymorph(Turtle)")then SendChatMessage(format("%.0f",-1*(GetTime()-x)).." secs left on "..UnitName("focus").."'s CC!","EMOTE");end end
			</pre>

	<pre>/run for i=1,40 do local n,_,_,_,_,_,t=UnitDebuff("target",i);if (n=="Polymorph") or (n=="Polymorph: Pig") or (n=="Polymorph: Turtle") then SendChatMessage(t.." seconds left on CC","SAY");end end </pre>

	~~Macro to retrieve target's timeLeft for any of the three Mage Poly spells and announce it via "SAY".~~

	== History ==		== History ==

WoWWiki>Charibot: catfix, Replaced: Interface Customization → Interface customization

2008-07-08T22:23:58Z

catfix, Replaced: Interface Customization → Interface customization

← Older revision		Revision as of 22:23, 8 July 2008
Line 39:		Line 39:

	: [[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?]]
	: [[HOWTO: Identify Buffs Using Textures]]		: [[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]]

WoWWiki>Ansu at 07:10, 26 April 2008

2008-04-26T07:10:56Z

← Older revision		Revision as of 07:10, 26 April 2008
Line 3:		Line 3:
	Retrieve info about a certain debuff on a certain unit.		Retrieve info about a certain debuff on a certain unit.

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

	== Parameters ==		== Parameters ==

WoWWiki>Funkydude: /* Returns */ typo

2007-11-02T01:46:15Z

Returns: typo

← Older revision		Revision as of 01:46, 2 November 2007
Line 18:		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.
	:; timeLeft : Number - Time until the debuff expires, in seconds; nil if the ~~deubff~~ was not cast by the player.		:; timeLeft : Number - Time until the debuff expires, in seconds; nil if the debuff was not cast by the player.

	== Example ==		== Example ==