WoW:API GetBattlefieldTeamInfo: Difference between revisions

← Older edit

WoW:API GetBattlefieldTeamInfo (source)

Revision as of 04:45, 15 August 2023

234 bytes removed , 15 August 2023

m

Move page script moved page API GetBattlefieldTeamInfo to WoW:API GetBattlefieldTeamInfo without leaving a redirect

Anonymous user

Move page script

@@ Line 1: / Line 1: @@
-Gets information about an Arena Team
+{{wowapi}}
+Returns information regarding an Arena team
+ teamName, oldTeamRating, newTeamRating, teamRating = GetBattlefieldTeamInfo( index );
-      teamName, teamRating, newTeamRating = GetBattlefieldTeamInfo(index);
+== Parameters ==
+=== Arguments ===
+:( index )
-==Parameters==
+:;index : Integer - Which team to get information on, 0 is Green team and 1 is Gold Team
-===Arguments===
-index - The index of the team to return. Values are 0 and 1. For unregistered games, 0 = Green team and 1 = Gold Team
+----
+=== Returns ===
+: teamName, oldTeamRating, newTeamRating
-==Returns==
+:;teamName : String - Teams name inside a rated arena match.
+:;oldTeamRating : Integer - Old rating that the team entered with (0 is no team is found)
+:;newTeamRating : Integer - New rating that the team is leaving with
+:;teamRating : Integer - Formerly known as ''match making rating''
-:teamName, teamRating, newTeamRating
+----
+=== Details ===
-:; teamName - String representing the Registered team's name
+This cannot be used until the arena has ended and UPDATE_BATTLEFIELD_SCORE is fired, if for some reason a game ends as soon as it starts with no enemy team joining, oldTeamRating will be 0.
-:; teamRating - Integer representing the team's arena rating points when they entered the arena.
-:; newTeamRating - Integer representing the team's rating calculated at the end of the match.
-==Remarks==
-This function seems to only work for registered team games. if the function returns the value 0 for teamRating then the team is not a registered team. Taking the difference of newTeamRating and teamRating will give the net gain of arena rating points. Take note that arena rating points are the currency used to buy Arena Vendored items. These points don't directly relate to the team's rank on the server.
-At this stage, the colours used for both skirmish and ranked games are gold and green.