WoW:API GetPVPRankInfo: Difference between revisions

WoW:API GetPVPRankInfo (source)

688 bytes added , 9 May 2005

m

deleted old contents

Anonymous user

@@ Line 1: / Line 1: @@
-'''rankName, rankNumber = GetPVPRankInfo(rank [, unit])'''
+'''GetPVPRankInfo(rank [, unit])'''
-Get information about a specific rank (Second arg not used by UI)
+Get information about a specific rank.
+ rankName, rankNumber = GetPVPRankInfo(rank [, unit]);
+----
+;''Arguments''
+:(rank [, unit])
+:;rank : Number - Specifies the number of the rank (as returned by [[API_UnitPVPRank|UnitPVPRank("unit")]])
+:;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
+----
+;''Example''
+ if (UnitPVPRank("mouseover") >= 1) then
+     rankName = GetPVPRankInfo(UnitPVPRank("mouseover"), "mouseover");
+     -- rankName now contains the localized rank for mousover unit (e.g. grunt or similar).
+ end
+----
+{{WoW API}}