WoW:API GetArenaTeam: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
m (Move page script moved page API GetArenaTeam to API GetArenaTeam without leaving a redirect)
 
(2 intermediate revisions by 2 users not shown)
Line 2: Line 2:
Requests information regarding the arena team that the player is in, see Returns for a full list of what this returns.
Requests information regarding the arena team that the player is in, see Returns for a full list of what this returns.


  teamName, teamSize, teamRating, weekPlayed, weekWins, seasonPlayed, seasonWins, playerPlayed, teamRank = GetArenaTeam(id);
  teamName, teamSize, teamRating, weekPlayed, weekWins, seasonPlayed, seasonWins, playerPlayed, seasonPlayerPlayed, teamRank, playerRating = GetArenaTeam(id);


== Parameters ==
== Parameters ==
Line 20: Line 20:
:;seasonWins : Integer - Total games that the team has played this season
:;seasonWins : Integer - Total games that the team has played this season
:;playerPlayed : Integer - Total games that the player has played this week
:;playerPlayed : Integer - Total games that the player has played this week
:;teamRank : Integer - Current ranking the team is, this is typically updated when arena points calculate
:;seasonPlayerPlayed : Integer - Total games that the player has played this season
:;teamRank : Integer - Teams current ranking, this is updated once a week typically when points are calculated
:;personalRating : Integer - Players personal rating with this team
:;background (red) : Float - Amount of red in the teams banner background
:;background (red) : Float - Amount of red in the teams banner background
:;background (green) : Float - Amount of green in the teams banner background
:;background (green) : Float - Amount of green in the teams banner background

Latest revision as of 04:45, 15 August 2023

WoW API < GetArenaTeam

Requests information regarding the arena team that the player is in, see Returns for a full list of what this returns.

teamName, teamSize, teamRating, weekPlayed, weekWins, seasonPlayed, seasonWins, playerPlayed, seasonPlayerPlayed, teamRank, playerRating = GetArenaTeam(id);

Parameters[edit]

Arguments[edit]

index
Index of the team you want information on, can be a value between 1 and 3.

Returns[edit]

teamName
String - Teams name, nil if they aren't on a team or the data wasn't received yet.
teamSize
Integer - Team size (2, 3 or 5)
teamRating
Integer - Teams rating, for a team that hasn't played any games this season it'll be 1500
weekPlayed
Integer - Total games the team has played for the current week
weekWins
Integer - Total games the team has won for the current week
seasonPlayed
Integer - Total games that the team has played this season
seasonWins
Integer - Total games that the team has played this season
playerPlayed
Integer - Total games that the player has played this week
seasonPlayerPlayed
Integer - Total games that the player has played this season
teamRank
Integer - Teams current ranking, this is updated once a week typically when points are calculated
personalRating
Integer - Players personal rating with this team
background (red)
Float - Amount of red in the teams banner background
background (green)
Float - Amount of green in the teams banner background
background (blue)
Float - Amount of blue in the teams banner background
emblem
Integer - Emblem graphic name
emblem - (red)
Float - Amount of red in the teams emblem color
emblem - (green)
Float - Amount of green in the teams emblem color
emblem (blue)
Float - Amount of blue in the teams emblem color
border
Integer - Border graphic name
border (red)
Float - Amount of red in the teams border color
border (green)
Float - Amount of green in the teams border color
border (blue)
Float - Amount of blue in the teams border color

Details[edit]

The team information is not kept up to date ARENA_TEAM_UPDATE is fired when the client gets the team information. The game will call ArenaTeamRoster when the player first logs in and when the game ends.

Emblem graphics are located in Interface\\PVPFrame\\Icons\\PVP-Banner-Emblem-## Interface\\PVPFrame\\PVP-Banner-<TEAM SIZE>-Border-<BORDER NUMBER>