WoW:API GetBattlefieldScore: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(changed argument "filename" to "classToken" as thats more accurate and consistant with other API pages)
No edit summary
Line 26: Line 26:
:;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.
----
=== 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>
<br><center>''Last updated: Patch 2.0''</center>

Revision as of 23:23, 6 September 2008

WoW API < GetBattlefieldScore

Returns information about a player's score in battlegrounds.

name, killingBlows, honorKills, deaths, honorGained, faction, rank, race, class, filename, damageDone, healingDone = GetBattlefieldScore(index);

Parameters

Arguments

( index )
index
Integer - The characters index in battlegrounds.

Returns

name, killingBlows, honorKills, deaths, honorGained, faction, rank, race, class, classToken, damageDone, healingDone
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.
honorKills
Integer - Number of honourable kills.
deaths
Integer - The number of deaths.
honorGained
Integer - The amount of honour gained so far (Bonus Honour).
faction
Integer - (Battlegrounds: Horde = 0, Alliance = 1 / Arenas: Green Team = 0, Yellow Team = 1).
rank
Integer - The players rank (0 - 14).
race
String - The players race (Orc, Undead, Human, 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.

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



Last updated: Patch 2.0