WoW:API GetBattlefieldWinner: Difference between revisions

Revision as of 17:30, 12 July 2006

Get the winner of the battleground

battlefieldWinner = GetBattlefieldWinner()

None

battlefieldWinner

battlefieldWinner: Integer - A code indicating the battleground winner. (nil for no one; 0 for Horde; 1 for Alliance)

Gets the winner of the current battleground that the player is inside.

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

@@ Line 1: / Line 1: @@
-{{wowapi}}
+Get the winner of the battleground
-<center>'''GetBattlefieldWinner()''' ''-Documentation by [[user:Klishu|Klishu]]-''</center>
-<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
-Returns an integer value based on the winner of the Battleground.
-<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
+  battlefieldWinner = GetBattlefieldWinner()
-  winnerCode = GetBattlefieldWinner()
 == Parameters ==
 === Arguments ===
-<!-- List each argument, together with its type -->
 None
 === Returns ===
-<!-- List each return value, together with its type -->
+:battlefieldWinner
-:winnerCode
-:;winnerCode : integer - A code indicating if you've won the current battleground. (nil for no; 1 for yes)
+:;battlefieldWinner: Integer - A code indicating the battleground winner. (nil for no one; 0 for Horde; 1 for Alliance)
 ==Details==
-<!-- Details not appropriate for the main description can go here -->
-: Returns an interger value which can be nil or 1 indicating whether the player has won the current battleground he is in. Returns nil if the player is not in a battleground or the battle still hasn't ended yet.
+: Gets the winner of the current battleground that the player is inside.
 ----
 __NOTOC__
+{{wowapi}}