WoW:API GetBattlefieldScore: Difference between revisions

m
Move page script moved page API GetBattlefieldScore to WoW:API GetBattlefieldScore without leaving a redirect
No edit summary
m (Move page script moved page API GetBattlefieldScore to WoW:API GetBattlefieldScore without leaving a redirect)
 
(3 intermediate revisions by 3 users not shown)
Line 12: Line 12:
----
----
=== Returns ===
=== Returns ===
:name, killingBlows, honorKills, deaths, honorGained, faction, rank, race, class, filename, damageDone, healingDone
:name, killingBlows, honorKills, deaths, honorGained, faction, rank, race, class, classToken, damageDone, healingDone, bgRating, ratingChange


:;name : String - The player's name, with their server name attached if from a different server to the player.
:;name : String - The player's name, with their server name attached if from a different server to the player.
Line 19: Line 19:
:;deaths : Integer - The number of deaths.
:;deaths : Integer - The number of deaths.
:;honorGained : Integer - The amount of honour gained so far (Bonus Honour).
:;honorGained : Integer - The amount of honour gained so far (Bonus Honour).
:;faction : Integer - (Horde = 0, Alliance = 1).
:;faction : Integer - (Battlegrounds: Horde = 0, Alliance = 1 / Arenas: Green Team = 0, Yellow Team = 1).
:;rank : Integer - The players rank (0 - 14).
:;rank : Integer - The players rank (0 - 14).
:;race : String - The players race (Orc, Undead, Human, etc).
:;race : String - The players race (Orc, Undead, Human, etc).
:;class : String - The players class (Mage, Hunter, Warrior, etc).
:;class : String - The players class (Mage, Hunter, Warrior, etc).
:;filename: String - The player's class name in english given in all capitals (MAGE , HUNTER, WARRIOR, etc)
:;classToken: String - The player's class name in english given in all capitals (MAGE , HUNTER, WARRIOR, etc)
:;damageDone: Integer - The amount of damage done.
:;damageDone: Integer - The amount of damage done.
:;healingDone: Integer - The amount of healing done.
:;healingDone: Integer - The amount of healing done.
:;bgRating: Integer - The players current battleground rating. (0 if not rated)
:;ratingChange: Integer - The rating change (0 if not rated)


== Remarks ==
----
 
=== Example ===
How to count the number of players in each faction.
 
local numScores = GetNumBattlefieldScores()
local numHorde = 0
local numAlliance = 0
for i=1, numScores do
name, killingBlows, honorableKills, deaths, honorGained, faction, rank, race, class = GetBattlefieldScore(i);
if ( faction ) then
if ( faction == 0 ) then
numHorde = numHorde + 1
else
numAlliance = numAlliance + 1
end
end
end


The integer value returned for "faction" has various meanings. For all non-arena battlegrounds, 0 = Horde and 1 = Alliance. For arena, the value indicates the team index used for [[API GetBattlefieldTeamInfo|GetBattlefieldTeamInfo]]. 0 represents the green team and 1 represents the gold team. [[User:Salanex|Salanex]] 00:40, 16 February 2007 (EST)


<br><center>''Last updated: Patch 2.0''</center>
<br><center>''Last updated: Patch 2.0''</center>
Anonymous user