WoW:API GetPlayerBuffName: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Initial documentation)
 
m (Move page script moved page API GetPlayerBuffName to API GetPlayerBuffName without leaving a redirect)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{wowapi}} __NOTOC__
{{wowapi|removed=3.0|replace=Use {{api|UnitAura}} and derived functions instead.}}


<!-- 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"])
<!-- List each argument, together with its type -->
:(id) or ("name"[,"rank"])


:;id : Number - index from 1 to 16
== Parameters ==
:;name : String - name of the buff to retrieve
=== Arguments ===
:;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) - rank of the buff to retrieve, as returned by this function (Optional)
== Returns ==
<!-- List each return value, together with its type -->
:name, rank  <!-- remove this line if it's just one value -->
 
:;name : String - name of buff found
:;rank : String - rank of buff found


=== Returns ===
* name (string) - name 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.

Latest revision as of 04:46, 15 August 2023

Icon-remove-48x48.png This is no longer a part of the World of Warcraft API.
  • Use UnitAura and derived functions instead.
  • It was removed in patch 3.0.

← WoW API < GetPlayerBuffName

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. 

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

Parameters[edit]

Arguments[edit]

  • 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[edit]

  • name (string) - name of buff found
  • rank (string) - rank of buff found

Example[edit]

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

local buffName, buffRank = GetPlayerBuffName(1)
Result
buffName = "Devotion Aura"
buffRank = "Rank 1"

Notes[edit]

  • Removed in patch 3.0. Use UnitAura (or derived functions) to retrieve information about buffs.
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetPlayerBuffName&oldid=19225"