WoW:API GetBattlefieldWinner - Revision history

Move page script: Move page script moved page API GetBattlefieldWinner to WoW:API GetBattlefieldWinner without leaving a redirect

2023-08-15T04:45:46Z

Move page script moved page API GetBattlefieldWinner to API GetBattlefieldWinner without leaving a redirect

← Older revision

Revision as of 04:45, 15 August 2023

WoWWiki>Valana at 14:39, 9 April 2008

2008-04-09T14:39:27Z

← Older revision		Revision as of 14:39, 9 April 2008
Line 1:		Line 1:
	Get the winner of the battlefield		Get the winner of the battlefield

	winner= GetBattlefieldWinner()		winner = GetBattlefieldWinner()

	== Parameters ==		== Parameters ==
Line 11:		Line 11:
	==Details==		==Details==

	: Gets the winner of the ~~current~~ battleground that the player is ~~inside~~.		: Gets the winner of the battleground that the player is currently in.

	~~==Notes==~~

	: As of Patch 2.3.2 this is broken inside Battlegrounds and returns 255 if the game has been won instead of 0 or 1, it still works in Arena's however and will return 0 for Green Team and 1 for Gold Team
	~~----~~
	{{wowapi}}		{{wowapi}}

WoWWiki>Shadowed: /* Notes */ Cleaned up the note a little

2008-02-26T00:40:46Z

Notes: Cleaned up the note a little

← Older revision		Revision as of 00:40, 26 February 2008
Line 15:		Line 15:
	==Notes==		==Notes==

	: ~~Currently in~~ Patch 2.3.2 this is ~~half~~ broken~~. In~~ Arena's ~~it works.~~ 0 = Green Team, 1 = Gold Team~~. In Battlegrounds however, it just returns 255 regardless of any winner.~~		: As of Patch 2.3.2 this is broken inside Battlegrounds and returns 255 if the game has been won instead of 0 or 1, it still works in Arena's however and will return 0 for Green Team and 1 for Gold Team

	----		----
	{{wowapi}}		{{wowapi}}

WoWWiki>ActualFantasy at 19:24, 24 January 2008

2008-01-24T19:24:00Z

← Older revision		Revision as of 19:24, 24 January 2008
Line 15:		Line 15:
	==Notes==		==Notes==

	: Currently in Patch 2.3.0 this is broken ~~and returning nil when nobody has won~~, ~~and~~ 255 ~~if someone has won~~ regardless of ~~faction or team~~		: Currently in Patch 2.3.2 this is half broken. In Arena's it works. 0 = Green Team, 1 = Gold Team. In Battlegrounds however, it just returns 255 regardless of any winner.

	----		----
	{{wowapi}}		{{wowapi}}

WoWWiki>Shadowed: Cleaned up a bit, and added info about it being broken in 2.3.0

2007-11-19T23:46:34Z

Cleaned up a bit, and added info about it being broken in 2.3.0

← Older revision		Revision as of 23:46, 19 November 2007
Line 1:		Line 1:
	Get the winner of the ~~battleground~~		Get the winner of the battlefield

	~~battlefieldWinner~~ = GetBattlefieldWinner()		winner= GetBattlefieldWinner()

	== Parameters ==		== Parameters ==
	~~=== Arguments ===~~
	~~None~~

	=== Returns ===		=== Returns ===
	:~~battlefieldWinner~~		:winner

	:;~~battlefieldWinner~~: Integer - ~~A code indicating~~ the ~~battleground winner~~. (nil ~~for no one;~~ 0 for Horde; 1 for Alliance)		:;winner: Integer - Faction/team that has won the battlefield. Results are: nil if nobody has won, 0 for Horde and 1 for Alliance in a battleground, 0 for Green Team and 1 for Yellow in an arena.

	==Details==		==Details==

	: Gets the winner of the current battleground that the player is inside.		: Gets the winner of the current battleground that the player is inside.
	: ~~Within the scope of arena winners~~, ~~the integer returned is the index~~ of ~~the arena~~ team~~. Read the documentation for [[API GetBattlefieldTeamInfo\|GetBattlefieldTeamInfo]] for more information. [[User:Salanex\|Salanex]] 00:00, 16 February 2007 (EST)~~
			==Notes==

			: Currently in Patch 2.3.0 this is broken and returning nil when nobody has won, and 255 if someone has won regardless of faction or team

	----		----
	~~__NOTOC__~~
	{{wowapi}}		{{wowapi}}

WoWWiki>Salanex: /* Details */

2007-02-16T05:03:21Z

Details

← Older revision		Revision as of 05:03, 16 February 2007
Line 15:		Line 15:

	: Gets the winner of the current battleground that the player is inside.		: Gets the winner of the current battleground that the player is inside.
			: Within the scope of arena winners, the integer returned is the index of the arena team. Read the documentation for [[API GetBattlefieldTeamInfo\|GetBattlefieldTeamInfo]] for more information. [[User:Salanex\|Salanex]] 00:00, 16 February 2007 (EST)

	----		----
	__NOTOC__		__NOTOC__
	{{wowapi}}		{{wowapi}}

WoWWiki>Shadowed: Forgot to change some things when changing this to another format

2006-07-12T17:30:59Z

Forgot to change some things when changing this to another format

← Older revision		Revision as of 17:30, 12 July 2006
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 ==		== Parameters ==
	=== Arguments ===		=== Arguments ===
	~~<!-- List each argument, together with its type -->~~
	None		None

	=== Returns ===		=== 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==
	~~<!-- 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__		__NOTOC__
			{{wowapi}}

WoWWiki>Klishu at 15:29, 12 July 2006

2006-07-12T15:29:23Z

← Older revision		Revision as of 15:29, 12 July 2006
Line 1:		Line 1:
			{{wowapi}}

	<center>'''GetBattlefieldWinner()''' ''-Documentation by [[user:Klishu\|Klishu]]-''</center>		<center>'''GetBattlefieldWinner()''' ''-Documentation by [[user:Klishu\|Klishu]]-''</center>

Line 16:		Line 18:
	:winnerCode		:winnerCode

	:;winnerCode : integer - A code indicating the battleground ~~winner~~. (nil for no ~~one; 0 for Horde~~; 1 for ~~Alliance~~)		:;winnerCode : integer - A code indicating if you've won the current battleground. (nil for no; 1 for yes)

	==Details==		==Details==
	<!-- Details not appropriate for the main description can go here -->		<!-- Details not appropriate for the main description can go here -->

	: Returns an interger value which can be nil~~, 0~~ or 1 indicating the ~~winner of~~ the current battleground the player is in~~. If the~~ battleground ~~isn't finished~~ or ~~they aren~~'t ~~inside one nil is returned~~.		: 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.

	----		----
	__NOTOC__		__NOTOC__
	~~{{Template:WoW API}}~~

WoWWiki>Shadowed: /* Returns */ Returns nil, 0 or 1 not nil, 1, 2

2006-07-12T04:32:25Z

Returns: Returns nil, 0 or 1 not nil, 1, 2

← Older revision		Revision as of 04:32, 12 July 2006
Line 16:		Line 16:
	:winnerCode		:winnerCode

	:;winnerCode : integer - A code indicating the battleground winner. (nil for no one; 1 for Alliance~~; 2 for Horde~~)		:;winnerCode : integer - A code indicating the battleground winner. (nil for no one; 0 for Horde; 1 for Alliance)

	==Details==		==Details==
	<!-- Details not appropriate for the main description can go here -->		<!-- Details not appropriate for the main description can go here -->

	: Returns an ~~integer~~ value which can be ~~either~~ nil, 1 ~~or 2~~ indicating the winner of the current battleground the player is in. If the ~~player~~ isn't ~~in a battleground~~ or it'~~s still not finished~~ nil is returned.		: Returns an interger value which can be nil, 0 or 1 indicating the winner of the current battleground the player is in. If the battleground isn't finished or they aren't inside one nil is returned.

	----		----
	__NOTOC__		__NOTOC__
	{{Template:WoW API}}		{{Template:WoW API}}

WoWWiki>Klishu at 16:55, 5 June 2006

2006-06-05T16:55:20Z

New page

<center>'''GetBattlefieldWinner()''' ''-Documentation by [[user:Klishu|Klishu]]-''</center>


Returns an integer value based on the winner of the Battleground.


winnerCode = GetBattlefieldWinner()

== Parameters ==
=== Arguments ===

None

=== Returns ===

:winnerCode

:;winnerCode : integer - A code indicating the battleground winner. (nil for no one; 1 for Alliance; 2 for Horde)

==Details==


: Returns an integer value which can be either nil, 1 or 2 indicating the winner of the current battleground the player is in. If the player isn't in a battleground or it's still not finished nil is returned.

----
__NOTOC__
{{Template:WoW API}}