WoW:API GetBattlefieldScore: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
(changed argument "filename" to "classToken" as thats more accurate and consistant with other API pages)
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


:;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.
== Remarks ==
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>

Revision as of 08:06, 31 January 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.


Last updated: Patch 2.0