WoW:API GetPlayerBuffName - Revision history

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

2023-08-15T04:46:19Z

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

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

Bear at 21:48, 12 February 2021

2021-02-12T21:48:08Z

← Older revision		Revision as of 21:48, 12 February 2021
Line 1:		Line 1:
	{{~~removedapi~~\|3.0\|Use {{api\|UnitAura}} ~~(or~~ derived functions~~) to retrieve information about buffs~~.}}		{{wowapi\|removed=3.0\|replace=Use {{api\|UnitAura}} and derived functions instead.}}
	~~{{wowapi}} __NOTOC__~~

	~~<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->~~
	Used to retrieve the name and rank of a buff in a given index, or to verify a buff with the given name (and optionally, rank) is present.		Used to retrieve the name and rank of a buff in a given index, or to verify a buff with the given name (and optionally, rank) is present.
	~~<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->~~
	~~name, rank = GetPlayerBuffName(id, or "name"[,"rank"])~~

	=~~= Arguments ==~~		local name, rank = GetPlayerBuffName(id, or "name"[,"rank"])
	;id ~~: Number - index from 1 to 16~~
	;name ~~: String - name of the buff to retrieve~~
	;rank ~~: String (Optional) - rank of the buff to retrieve (as returned by this function~~)

			== Parameters ==
			=== Arguments ===
			* id (number) - index from 1 to 16
			* name (string) - name of the buff to retrieve
			* rank (string) - rank of the buff to retrieve, as returned by this function (Optional)

	== Returns ==		=== Returns ===
	;name ~~: String~~ - name of buff found		* name (string) - name of buff found
	;rank ~~: String~~ - rank of buff found		* rank (string) - rank of buff found


	== Example ==		== Example ==
	~~<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->~~		Called on a paladin with Devotion Aura (Rank 1) in buff slot 1
	local buffName, buffRank = GetPlayerBuffName(1)		local buffName, buffRank = GetPlayerBuffName(1)
	~~(called on a paladin with Devotion Aura(Rank 1) in buff slot 1)~~

	~~<big>'''~~Result~~'''</big>~~		;Result
	~~<!-- If it helps, include example results here, though they are not required. You're allowed to cheat liberally since WoW isn't a command line language. -->~~
	buffName = "Devotion Aura"		buffName = "Devotion Aura"
	buffRank = "Rank 1"		buffRank = "Rank 1"

			== Notes ==
			* Removed in patch 3.0. Use {{api\|UnitAura}} (or derived functions) to retrieve information about buffs.

WoWWiki>Starlightblunder: removedapi

2009-05-28T12:50:25Z

removedapi

← Older revision		Revision as of 12:50, 28 May 2009
Line 1:		Line 1:
			{{removedapi\|3.0\|Use {{api\|UnitAura}} (or derived functions) to retrieve information about buffs.}}
	{{wowapi}} __NOTOC__		{{wowapi}} __NOTOC__

Line 7:		Line 8:

	== Arguments ==		== Arguments ==
	~~<!-- List each argument, together with its type -->~~		;id : Number - index from 1 to 16
	~~:(id) or ("name"[,"rank"])~~		;name : String - name of the buff to retrieve
			;rank : String (Optional) - rank of the buff to retrieve (as returned by this function)
	:;id : Number - index from 1 to 16
	:;name : String - name of the buff to retrieve
	:;rank : String (Optional) - rank of the buff to retrieve (as returned by this function)


	== Returns ==		== Returns ==
	~~<!-- List each return value, together with its type -->~~		;name : String - name of buff found
	~~:name, rank <!-- remove this line if it's just one value -->~~		;rank : String - rank of buff found

	:;name : String - name of buff found
	:;rank : String - rank of buff found

WoWWiki>Ergh99: Initial documentation

2007-09-11T21:01:54Z

Initial documentation

New page

{{wowapi}} __NOTOC__


Used to retrieve the name and rank of a buff in a given index, or to verify a buff with the given name (and optionally, rank) is present.

name, rank = GetPlayerBuffName(id, or "name"[,"rank"])

== Arguments ==

:(id) or ("name"[,"rank"])

:;id : Number - index from 1 to 16
:;name : String - name of the buff to retrieve
:;rank : String (Optional) - rank of the buff to retrieve (as returned by this function)

== Returns ==

:name, rank 

:;name : String - name of buff found
:;rank : String - rank of buff found

== Example ==

local buffName, buffRank = GetPlayerBuffName(1)
(called on a paladin with Devotion Aura(Rank 1) in buff slot 1)

<big>'''Result'''</big>

buffName = "Devotion Aura"
buffRank = "Rank 1"