WoW API: GetArenaTeam

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 < GetArenaTeam

Documentation by Salanex

Gets basic information about an arena team that you are in.

teamName, teamSize, teamRating, teamPlayed, teamWins, playerPlayed, teamRank = GetArenaTeam(teamIndex);

Arguments

teamIndex - integer

values

1 - 3. You can be in a maximum of three arena teams.

Return Values

teamName

(string) the full string that represents the team's name

teamSize

(integer) the number of players that can compete at a time in arena.

values

2, 3 and 5 for 2v2, 3v3 and 5v5

teamRating

(integer) the team's current arena rating

teamPlayed

(integer) the number of games the team has played this week

teamWins

(integer) the number of wins for the week

playerPlayed

(integer) untested but most likely the number of games you have played for the team this week

teamRank

(integer) the ranking of the team within it's battlegroup.

Remarks

The function actually returns many more values but they are in relation to the banner icon, colours etc.

Calling this function without having called ArenaTeamRoster(teamIndex) previously will result in unexpected results or outdated information.