WoW:API UnitBuff - Revision history

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

2023-08-15T04:47:42Z

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

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

Bear: 1 revision

2020-05-15T22:26:41Z

1 revision

← Older revision		Revision as of 22:26, 15 May 2020
Line 11:		Line 11:
	== Returns ==		== Returns ==
	;name : String - The name of the spell or effect of the buff, or nil if no buff 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 buff, or nil if no buff 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 buff. Returns "" if there is no rank.		;rank : String - The rank line from the tooltip of the spell or effect that caused the buff, e.g. "Rank 2". Returns "" if there is no rank.
	;iconTexture : String - The identifier of (path and filename to) the indicated buff.		;iconTexture : String - The identifier of (path and filename to) the indicated buff.
	;count : Number - The number of times the buff has been applied to the target.		;count : Number - The number of times the buff has been applied to the target.

WoWWiki>EWOlson: Correction of grammar.

2013-07-15T07:00:07Z

Correction of grammar.

← Older revision		Revision as of 07:00, 15 July 2013
Line 1:		Line 1:
	{{wowapi}} __NOTOC__		{{wowapi}} __NOTOC__
	~~Retrieve~~ info about a certain buff on a certain unit. This essentially an alias of [[API_UnitAura\|UnitAura]] with the "HELPFUL" filter.		Retrieves info about a certain buff on a certain unit. This is essentially an alias of [[API_UnitAura\|UnitAura]] with the "HELPFUL" filter.
	name, rank, icon, count, debuffType, duration, expirationTime, unitCaster, isStealable,		name, rank, icon, count, debuffType, duration, expirationTime, unitCaster, isStealable,
	shouldConsolidate, spellId = UnitBuff("unit", index or ["name", "rank"][, "filter"])		shouldConsolidate, spellId = UnitBuff("unit", [index] or ["name", "rank"][, "filter"])

	== Arguments ==		== Arguments ==

WoWWiki>Davegibbs at 15:25, 1 April 2010

2010-04-01T15:25:56Z

← Older revision		Revision as of 15:25, 1 April 2010
Line 1:		Line 1:
	{{wowapi}} __NOTOC__		{{wowapi}} __NOTOC__
	Retrieve info about a certain buff on a certain unit. This essentially an alias of [[API_UnitAura\|UnitAura]] with the "HELPFUL" filter.		Retrieve info about a certain buff on a certain unit. This essentially an alias of [[API_UnitAura\|UnitAura]] with the "HELPFUL" filter.
	name, rank, icon, count, debuffType, duration, expirationTime, unitCaster, isStealable, shouldConsolidate, spellId		name, rank, icon, count, debuffType, duration, expirationTime, unitCaster, isStealable,
	= UnitBuff("unit", index or ["name", "rank"][, "filter"])		shouldConsolidate, spellId = UnitBuff("unit", index or ["name", "rank"][, "filter"])

	== Arguments ==		== Arguments ==

WoWWiki>Starlightblunder: returns, fix things

2009-12-15T13:34:01Z

returns, fix things

← Older revision		Revision as of 13:34, 15 December 2009
Line 1:		Line 1:
	{{wowapi}} __NOTOC__		{{wowapi}} __NOTOC__
	Retrieve info about a certain buff on a certain unit. This essentially an alias of [[API_UnitAura\|UnitAura]] with the "HELPFUL" filter.		Retrieve info about a certain buff on a certain unit. This essentially an alias of [[API_UnitAura\|UnitAura]] with the "HELPFUL" filter.
	name, rank, icon, count, debuffType, duration, expirationTime, ~~source~~, isStealable		name, rank, icon, count, debuffType, duration, expirationTime, unitCaster, isStealable, shouldConsolidate, spellId
	= UnitBuff(unit, index or name [, ~~castable~~])		= UnitBuff("unit", index or ["name", "rank"][, "filter"])

	== Arguments ==		== Arguments ==
	;unitId : String - The [[unitId\|unit]] to query information for		;unitId : String - The [[unitId\|unit]] to query information for
	;index or name : Number or string - The index or name of the buff to retrieve information for. Indices start at 1 and go up indefinitely until there are no more buffs on target.		;index or name : Number or string - The index or name of the buff to retrieve information for. Indices start at 1 and go up indefinitely until there are no more buffs on target.
	;~~castable~~ : ~~Boolean~~ - ~~If present and true~~ (1)~~, then only player-castable buffs will be returned; buffIndex still starts at 1~~.		;filter : String - zero or more of "PLAYER", "RAID", "CANCELABLE", "NOT_CANCELABLE", separated by pipe ("\|") or space characters.

	== Returns ==		== Returns ==
Line 19:		Line 19:
	;source : String - The [[unitId\|unit]] that cast the buff		;source : String - The [[unitId\|unit]] that cast the buff
	;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).
			;spellId : Number - spell ID of the aura.

	== Example ==		== Example ==

WoWWiki>Tifi: isMine->source

2009-06-07T21:14:46Z

isMine->source

← Older revision		Revision as of 21:14, 7 June 2009
Line 1:		Line 1:
	{{wowapi}} __NOTOC__		{{wowapi}} __NOTOC__
	Retrieve info about a certain buff on a certain unit. This essentially an alias of [[API_UnitAura\|UnitAura]] with the "HELPFUL" filter.		Retrieve info about a certain buff on a certain unit. This essentially an alias of [[API_UnitAura\|UnitAura]] with the "HELPFUL" filter.
	name, rank, icon, count, debuffType, duration, expirationTime, ~~isMine~~, isStealable		name, rank, icon, count, debuffType, duration, expirationTime, source, isStealable
	= UnitBuff(unit, index or name [, castable])		= UnitBuff(unit, index or name [, castable])

Line 17:		Line 17:
	;duration : Number - The full duration of the buff in seconds		;duration : Number - The full duration of the buff in seconds
	;expirationTime : Number - Time the buff will expire in seconds		;expirationTime : Number - Time the buff will expire in seconds
	;~~isMine~~ : String - The [[unitId\|unit]] that cast the buff		;source : String - The [[unitId\|unit]] that cast the buff
	;isStealable : Boolean - 1 if it is stealable otherwise nil		;isStealable : Boolean - 1 if it is stealable otherwise nil

Line 51:		Line 51:
	* Patch 2.4 (Live) has corrected the bug introduced in 2.3.2. The castable parameter correctly filters non-castable buffs once again.		* Patch 2.4 (Live) has corrected the bug introduced in 2.3.2. The castable parameter correctly filters non-castable buffs once again.
	* Patch 3.0 updated the return values.		* Patch 3.0 updated the return values.
	* Patch 3.1 ~~updated~~ the return value:isMine		* Patch 3.1 changed the boolean return value isMine to the string value source.

	== See also ==		== See also ==

WoWWiki>Starlightblunder: unindent definition lists

2009-05-28T13:08:10Z

unindent definition lists

← Older revision		Revision as of 13:08, 28 May 2009
Line 1:		Line 1:
	{{wowapi}} __NOTOC__		{{wowapi}} __NOTOC__
	Retrieve info about a certain buff on a certain unit. This essentially an alias of [[API_UnitAura\|UnitAura]] with the "HELPFUL" filter.		Retrieve info about a certain buff on a certain unit. This essentially an alias of [[API_UnitAura\|UnitAura]] with the "HELPFUL" filter.
	name, rank, icon, count, debuffType, duration, expirationTime, isMine, isStealable = UnitBuff(unit, index or name [, castable])		name, rank, icon, count, debuffType, duration, expirationTime, isMine, isStealable
			= UnitBuff(unit, index or name [, castable])

	== ~~Parameters~~ ==		== Arguments ==
	~~=== Arguments ===~~		;unitId : String - The [[unitId\|unit]] to query information for
			;index or name : Number or string - The index or name of the buff to retrieve information for. Indices start at 1 and go up indefinitely until there are no more buffs on target.
			;castable : Boolean - If present and true (1), then only player-castable buffs will be returned; buffIndex still starts at 1.

	~~:;unitId : String - The [[unitId\|unit]] to query information for~~		== Returns ==
	~~:;index or name : Number or string - The index or name of the buff to retrieve information for. Indices start at 1 and go up indefinitely until there are no more buffs on target.~~		;name : String - The name of the spell or effect of the buff, or nil if no buff was found with the specified name or at the specified index. This is the name shown in yellow when you mouse over the icon.
	~~:;castable : Boolean - If present and true (1), then only player-castable buffs will be returned; buffIndex still starts at 1.~~		;rank : String - The rank of the spell or effect that caused the buff. Returns "" if there is no rank.
			;iconTexture : String - The identifier of (path and filename to) the indicated buff.
	=== Returns ===		;count : Number - The number of times the buff has been applied to the target.
	:;name : String - The name of the spell or effect of the buff, or nil if no buff was found with the specified name or at the specified index. This is the name shown in yellow when you mouse over the icon.		;debuffType : String - The magic type of the buff
	:;rank : String - The rank of the spell or effect that caused the buff. Returns "" if there is no rank.		;duration : Number - The full duration of the buff in seconds
	:;iconTexture : String - The identifier of (path and filename to) the indicated buff.		;expirationTime : Number - Time the buff will expire in seconds
	:;count : Number - The number of times the buff has been applied to the target.		;isMine : String - The [[unitId\|unit]] that cast the buff
	:;debuffType : String - The magic type of the buff		;isStealable : Boolean - 1 if it is stealable otherwise nil
	:;duration : Number - The full duration of the buff in seconds
	:;expirationTime : Number - Time the buff will expire in seconds
	:;isMine : String - The [[unitId\|unit]] that cast the buff
	:;isStealable : Boolean - 1 if it is stealable otherwise nil

	== Example ==		== Example ==

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

2009-05-09T07:42:29Z

Returns: English: casted -> cast

← Older revision		Revision as of 07:42, 9 May 2009
Line 18:		Line 18:
	:;duration : Number - The full duration of the buff in seconds		:;duration : Number - The full duration of the buff in seconds
	:;expirationTime : Number - Time the buff will expire in seconds		:;expirationTime : Number - Time the buff will expire in seconds
	:;isMine : String - The [[unitId\|unit]] ~~which~~ the buff ~~casted by~~		:;isMine : String - The [[unitId\|unit]] that cast the buff
	:;isStealable : Boolean - 1 if it is stealable otherwise nil		:;isStealable : Boolean - 1 if it is stealable otherwise nil

WoWWiki>Voidexist: Patch 3.1 updated the return value:isMine

2009-04-16T02:41:36Z

Patch 3.1 updated the return value:isMine

← Older revision		Revision as of 02:41, 16 April 2009
Line 18:		Line 18:
	:;duration : Number - The full duration of the buff in seconds		:;duration : Number - The full duration of the buff in seconds
	:;expirationTime : Number - Time the buff will expire in seconds		:;expirationTime : Number - Time the buff will expire in seconds
	:;isMine : ~~Boolean~~ - ~~1 if it is~~ casted by ~~you otherwise nil~~		:;isMine : String - The [[unitId\|unit]] which the buff casted by
	:;isStealable : Boolean - 1 if it is stealable otherwise nil		:;isStealable : Boolean - 1 if it is stealable otherwise nil

Line 52:		Line 52:
	* Patch 2.4 (Live) has corrected the bug introduced in 2.3.2. The castable parameter correctly filters non-castable buffs once again.		* Patch 2.4 (Live) has corrected the bug introduced in 2.3.2. The castable parameter correctly filters non-castable buffs once again.
	* Patch 3.0 updated the return values.		* Patch 3.0 updated the return values.
			* Patch 3.1 updated the return value:isMine

	== See also ==		== See also ==

WoWWiki>Starlightblunder: link caption

2008-12-17T13:35:27Z

link caption

← Older revision		Revision as of 13:35, 17 December 2008
Line 1:		Line 1:
	{{wowapi}} __NOTOC__		{{wowapi}} __NOTOC__
	Retrieve info about a certain buff on a certain unit.		Retrieve info about a certain buff on a certain unit. This essentially an alias of [[API_UnitAura\|UnitAura]] with the "HELPFUL" filter.
	name, rank, icon, count, debuffType, duration, expirationTime, isMine, isStealable = UnitBuff(unit, index or name [, castable])		name, rank, icon, count, debuffType, duration, expirationTime, isMine, isStealable = UnitBuff(unit, index or name [, castable])