WoW:API GetPVPRankInfo: Difference between revisions

m
Move page script moved page API GetPVPRankInfo to WoW:API GetPVPRankInfo without leaving a redirect
mNo edit summary
m (Move page script moved page API GetPVPRankInfo to WoW:API GetPVPRankInfo without leaving a redirect)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
'''GetPVPRankInfo(rank [, unit])'''
{{wowapi}} __NOTOC__
 


Get information about a specific rank.
Get information about a specific rank.
rankName, rankNumber = GetPVPRankInfo(rank [, unit]);


rankName, rankNumber = GetPVPRankInfo(rank [, unit]);


----
== Arguments ==
;''Arguments''


:(rank [, unit])
:(rank [, unit])
Line 12: Line 12:
:;unit : String - The [[API TYPE UnitId|UnitId]] to query (e.g. "player", "party2", "pet", "target", "mouseover" etc.). This argument is needed to return the correct rank for enemy units (otherwise it would return ranks of player's faction only).
:;unit : String - The [[API TYPE UnitId|UnitId]] to query (e.g. "player", "party2", "pet", "target", "mouseover" etc.). This argument is needed to return the correct rank for enemy units (otherwise it would return ranks of player's faction only).


----
;''Returns''


rankName, rankNumber
== Returns ==
:rankName, rankNumber
 
:; rankName : String - The rank's name
:; rankNumber : Number - The rank's number


----
 
;''Example''
== Examples ==
  if (UnitPVPRank("mouseover") >= 1) then
  if (UnitPVPRank("mouseover") >= 1) then
     rankName = GetPVPRankInfo(UnitPVPRank("mouseover"), "mouseover");
     rankName = GetPVPRankInfo(UnitPVPRank("mouseover"), "mouseover");
     -- rankName now contains the localized rank for mousover unit (e.g. grunt or similar).
     -- rankName now contains the localized rank for mousover unit (e.g. grunt or similar).
  end
  end
----
{{WoW API}}
[[Category:API Functions|GetPVPRankInfo]]
[[Category:API Honor Functions|GetPVPRankInfo]]
Anonymous user