WoW:API GetBattlefieldScore: Difference between revisions

m
Move page script moved page API GetBattlefieldScore to WoW:API GetBattlefieldScore without leaving a redirect
mNo edit summary
m (Move page script moved page API GetBattlefieldScore to WoW:API GetBattlefieldScore without leaving a redirect)
 
(11 intermediate revisions by 10 users not shown)
Line 1: Line 1:
<center>'''GetBattlefieldScore''' ''-Documentation by [[user:Darjk|Darjk]]-''</center>
{{wowapi}}
 
Returns information about a player's score in battlegrounds.
Returns information about a player's score in battlegrounds.
   
   
  name, killingBlows, honorKills, deaths, honorGained, faction, rank, race, class = GetBattlefieldScore(index);
  name, killingBlows, honorKills, deaths, honorGained, faction, rank, race, class, filename, damageDone, healingDone = GetBattlefieldScore(index);


== Parameters ==
== Parameters ==
Line 13: Line 12:
----
----
=== Returns ===
=== Returns ===
:name, killingBlows, honorKills, deaths, honorGained, faction, rank, race, class
:name, killingBlows, honorKills, deaths, honorGained, faction, rank, race, class, classToken, damageDone, healingDone, bgRating, ratingChange


:;name : String - The player's name.
:;name : String - The player's name, with their server name attached if from a different server to the player.
:;killingBlows : Integer - Number of killing blows.
:;killingBlows : Integer - Number of killing blows.
:;honorKills : Integer - Number of honourable kills.
:;honorKills : Integer - Number of honourable kills.
:;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 - ?
:;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).
:;classToken: String - The player's class name in english given in all capitals (MAGE , HUNTER, WARRIOR, etc)
:;damageDone: Integer - The amount of damage 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)


<br><center><i>Last updated: Patch 1.6.1</i></center>
----
----
=== 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
<br><center>''Last updated: Patch 2.0''</center>
----
__NOTOC__
__NOTOC__
{{Template:WoW API}}
[[Category:API Functions|GetBattlefieldScore]]
[[Category:API Battlefield Functions|GetBattlefieldScore]]
Anonymous user