WoW:API GetPlayerBuffName: Difference between revisions

Revision as of 12:50, 28 May 2009

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

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"])

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)

local buffName, buffRank = GetPlayerBuffName(1)

(called on a paladin with Devotion Aura(Rank 1) in buff slot 1)

Result

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

@@ Line 1: / Line 1: @@
+{{removedapi|3.0|Use {{api|UnitAura}} (or derived functions) to retrieve information about buffs.}}
 {{wowapi}} __NOTOC__
@@ Line 7: / Line 8: @@
 == 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 ==
-<!-- 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