API GetPVPRankInfo

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

→ WoW API

← WoW API < GetPVPRankInfo

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 UnitPVPRank("unit"))

unit 

String - The 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

rankName 

String - The rank's name

rankNumber 

Number - The rank's number

Examples

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