WoW:API GetBattlefieldStatus - Revision history

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

2023-08-15T04:45:45Z

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

← Older revision

Revision as of 04:45, 15 August 2023

WoWWiki>Byndris: /* Example */ arena's -> arenas

2008-07-29T11:33:30Z

Example: arena's -> arenas

← Older revision		Revision as of 11:33, 29 July 2008
Line 37:		Line 37:

	=== Example ===		=== Example ===
	Display a list of battlefield brackets and ~~arena's~~ you're currently queued for, pending confirmation, in, or just finished.		Display a list of battlefield brackets and arenas you're currently queued for, pending confirmation, in, or just finished.

	local status, mapName, instanceID, minlevel, maxlevel;		local status, mapName, instanceID, minlevel, maxlevel;

WoWWiki>WoWWiki-Varan: /* Example */

2008-05-03T01:48:01Z

Example

← Older revision		Revision as of 01:48, 3 May 2008
Line 47:		Line 47:
	DEFAULT_CHAT_FRAME:AddMessage(mapName .. string.format(" (%d-%d): ", minlevel, maxlevel) ..status);		DEFAULT_CHAT_FRAME:AddMessage(mapName .. string.format(" (%d-%d): ", minlevel, maxlevel) ..status);
	end		end
			end

WoWWiki>Shadowed: /* Details */ Updated for 2.4 info

2008-03-27T22:03:57Z

Details: Updated for 2.4 info

← Older revision		Revision as of 22:03, 27 March 2008
Line 24:		Line 24:

	Used for retrieving the status of the battlefields that the player is queued or inside of. If the player is not queued for a battlefield you request it'll return a status of none, requesting an index above 3 will return nil, map name will either be the last battlefield this index was used for or nil you should always use status to verify if it's an an active queue/game.		Used for retrieving the status of the battlefields that the player is queued or inside of. If the player is not queued for a battlefield you request it'll return a status of none, requesting an index above 3 will return nil, map name will either be the last battlefield this index was used for or nil you should always use status to verify if it's an an active queue/game.

			As of [[Patch 2.4.0]] map is displayed as "Eastern Kingdoms" during confirm status, and the real map is shown once it's changed to active. instanceID is now always 0 for arena matches as well.

	==== Status ====		==== Status ====

WoWWiki>WoWWiki-Waldo: forgot one.

2008-01-27T03:14:31Z

forgot one.

← Older revision		Revision as of 03:14, 27 January 2008
Line 2:		Line 2:
	Get the status of the battlefield that the player is either queued for or inside.		Get the status of the battlefield that the player is either queued for or inside.

	status, mapName, instanceID = GetBattlefieldStatus(index);		status, mapName, instanceID, lowestlevel, highestlevel, teamSize, registeredMatch = GetBattlefieldStatus(index);

	== Parameters ==		== Parameters ==

WoWWiki>Shadowed: /* Returns */ Updated returns levels, 2.0.1 been out for close to a year so shouldn't need new in anymore

2007-11-20T02:40:52Z

Returns: Updated returns levels, 2.0.1 been out for close to a year so shouldn't need new in anymore

← Older revision		Revision as of 02:40, 20 November 2007
Line 13:		Line 13:

	:;status : String - Battlefield status (none, queued, confirm, active, error)		:;status : String - Battlefield status (none, queued, confirm, active, error)
	:;map : String - Localized battlefield name ([[Warsong Gulch]], [[Arathi Basin]], [[Alterac Valley]] or ~~[[Eastern Kingdoms]]~~)		:;map : String - Localized battlefield name ([[Warsong Gulch]], [[Arathi Basin]], [[Alterac Valley]] or nil)
	:;instanceID : Integer - Battlefield instance (returns 0 until you are inside an active battlefield)		:;instanceID : Integer - Battlefield instance (returns 0 until you are inside an active battlefield)
	:;lowestLevel : Integer - Lowest level in the battleground that will be joining (10, 20, 30, 40, 51 or 60)		:;lowestLevel : Integer - Lowest level in the battleground that will be joining (10, 20, 30, 40, 51, 60, 61, 70)
	:;highestLevel : Integer - Highest level in the battleground that will be joining (19, 29, 39, 49 or 60)		:;highestLevel : Integer - Highest level in the battleground that will be joining (19, 29, 39, 49, 60, 69, 70)
	~~(''new in 2.0.1''~~)		:;teamSize: Integer - Team size of the battlefields queue (2, 3, 5 or 0 if not an arena queue)
	:;teamSize: Integer - ~~This appears to be used for arena's and is the team~~ size ~~for~~ the ~~arena~~ (2, 3, 5 or 0 if it's not an arena queue)		:;registeredMatch: Integer - Returns 1 if it's a registered arena queue, returns 0 if it's a skirimish or not an arena queue, use teamSize to check for arenas
	----		----

	=== Details ===		=== Details ===

	Used for retrieving the status of the ~~battlegrounds~~ that the player is queued or inside of~~, if~~ the player is not queued for ~~all 3 battlegrounds at once then passing~~ an index ~~higher then they are queued for~~ will return ~~none~~ for status ~~and [[Eastern Kingdoms]] as a map name.~~		Used for retrieving the status of the battlefields that the player is queued or inside of. If the player is not queued for a battlefield you request it'll return a status of none, requesting an index above 3 will return nil, map name will either be the last battlefield this index was used for or nil you should always use status to verify if it's an an active queue/game.
	~~Appears~~ to ~~return 0 for minlevel and maxlevel of Alterac Valley~~.

	==== Status ====		==== Status ====
	* queued - Waiting for a battlefield to become ready		* queued - Waiting for a battlefield to become ready, you're in the queue
	* confirm - Ready to join a battlefield		* confirm - Ready to join a battlefield
	* active - ~~You're inside~~ an active battlefield		* active - Inside an active battlefield
	* none - ~~Invalid index passed, not in queue~~ for anything		* none - Not queued for anything in this index
	* error - This should never happen		* error - This should never happen

	----		----

	=== Example ===		=== Example ===
	Display a list of battlefield brackets and arena's you're currently queued for, pending confirmation, in, or just finished.		Display a list of battlefield brackets and arena's you're currently queued for, pending confirmation, in, or just finished.

WoWWiki>Starlightblunder: NOTOC

2006-12-25T17:40:10Z

__NOTOC__

← Older revision		Revision as of 17:40, 25 December 2006
Line 1:		Line 1:
	{{wowapi}}		{{wowapi}} __NOTOC__
	Get the status of the battlefield that the player is either queued for or inside.		Get the status of the battlefield that the player is either queued for or inside.

WoWWiki>Shadowed: Renamed teamType to teamSize

2006-12-10T05:54:48Z

Renamed teamType to teamSize

← Older revision		Revision as of 05:54, 10 December 2006
Line 15:		Line 15:
	:;map : String - Localized battlefield name ([[Warsong Gulch]], [[Arathi Basin]], [[Alterac Valley]] or [[Eastern Kingdoms]])		:;map : String - Localized battlefield name ([[Warsong Gulch]], [[Arathi Basin]], [[Alterac Valley]] or [[Eastern Kingdoms]])
	:;instanceID : Integer - Battlefield instance (returns 0 until you are inside an active battlefield)		:;instanceID : Integer - Battlefield instance (returns 0 until you are inside an active battlefield)
			:;lowestLevel : Integer - Lowest level in the battleground that will be joining (10, 20, 30, 40, 51 or 60)
	~~(''new in 1.12'')~~		:;highestLevel : Integer - Highest level in the battleground that will be joining (19, 29, 39, 49 or 60)
	:;lowestLevel : Integer - ~~Appears to return the lowest~~ level in the battleground that will be joining (10, 20, 30, 40, 51 or 60)		(''new in 2.0.1'')
	:;highestLevel : Integer - ~~Appears to return the highest~~ level in the battleground that will be joining (19, 29, 39, 49 or 60)		:;teamSize: Integer - This appears to be used for arena's and is the team size for the arena (2, 3, 5 or 0 if it's not an arena queue)

	----		----

Line 36:		Line 35:
	----		----
	=== Example ===		=== Example ===
	Display a list of battlefield brackets you're currently queued for, pending confirmation, in, or just finished.		Display a list of battlefield brackets and arena's you're currently queued for, pending confirmation, in, or just finished.

	local status, mapName, instanceID, minlevel, maxlevel;		local status, mapName, instanceID, minlevel, maxlevel;
	for i=1, MAX_BATTLEFIELD_QUEUES do		for i=1, MAX_BATTLEFIELD_QUEUES do
	status, mapName, instanceID, minlevel, maxlevel = GetBattlefieldStatus(i);		status, mapName, instanceID, minlevel, maxlevel, teamSize = GetBattlefieldStatus(i);
	DEFAULT_CHAT_FRAME:AddMessage(mapName .. string.format(" (%d-%d): ", minlevel, maxlevel) ..status);		if( teamSize > 0 ) then
	end		DEFAULT_CHAT_FRAME:AddMessage(mapName .. string.format("%dvs%d (%d-%d): ", minlevel, maxlevel, teamType, teamType) ..status);
			else
			DEFAULT_CHAT_FRAME:AddMessage(mapName .. string.format(" (%d-%d): ", minlevel, maxlevel) ..status);
			end

WoWWiki>Starlightblunder: Slightly better example

2006-09-11T14:57:33Z

Slightly better example

← Older revision		Revision as of 14:57, 11 September 2006
Line 1:		Line 1:
			{{wowapi}}
	Get the status of the battlefield that the player is either queued for or inside.		Get the status of the battlefield that the player is either queued for or inside.

Line 24:		Line 25:

	Used for retrieving the status of the battlegrounds that the player is queued or inside of, if the player is not queued for all 3 battlegrounds at once then passing an index higher then they are queued for will return none for status and [[Eastern Kingdoms]] as a map name.		Used for retrieving the status of the battlegrounds that the player is queued or inside of, if the player is not queued for all 3 battlegrounds at once then passing an index higher then they are queued for will return none for status and [[Eastern Kingdoms]] as a map name.
			Appears to return 0 for minlevel and maxlevel of Alterac Valley.

	==== Status ====		==== Status ====
Line 34:		Line 36:
	----		----
	=== Example ===		=== Example ===
	~~Auto join~~ a battlefield ~~as soon as it~~'~~s ready to enter~~		Display a list of battlefield brackets you're currently queued for, pending confirmation, in, or just finished.

	for ~~i=1~~, ~~MAX_BATTLEFIELD_QUEUES do~~
	~~status~~, ~~mapName~~, ~~instanceID = GetBattlefieldStatus(i);~~
	~~if( status == "confirm" ) then~~
	~~AcceptBattlefieldPort( i, true );~~
	~~end~~

	-~~---~~		local status, mapName, instanceID, minlevel, maxlevel;
	~~{{wowapi}}~~		for i=1, MAX_BATTLEFIELD_QUEUES do
			status, mapName, instanceID, minlevel, maxlevel = GetBattlefieldStatus(i);
			DEFAULT_CHAT_FRAME:AddMessage(mapName .. string.format(" (%d-%d): ", minlevel, maxlevel) ..status);
			end

WoWWiki>Shadowed: /* Returns */

2006-07-28T18:51:15Z

Returns

← Older revision		Revision as of 18:51, 28 July 2006
Line 1:		Line 1:
			Get the status of the battlefield that the player is either queued for or inside.

	status, mapName, instanceID = GetBattlefieldStatus(index);		status, mapName, instanceID = GetBattlefieldStatus(index);

	~~Get~~ status ~~on a~~ battlefield		== Parameters ==
			=== Arguments ===

			:;index : Index of the battlefield you wish to view

			----
			=== Returns ===

			:;status : String - Battlefield status (none, queued, confirm, active, error)
			:;map : String - Localized battlefield name ([[Warsong Gulch]], [[Arathi Basin]], [[Alterac Valley]] or [[Eastern Kingdoms]])
			:;instanceID : Integer - Battlefield instance (returns 0 until you are inside an active battlefield)

	~~Value of index appears~~ to be the ~~Battlefield queue index. Changed from null argument to index~~ in ~~1.9~~		(''new in 1.12'')
			:;lowestLevel : Integer - Appears to return the lowest level in the battleground that will be joining (10, 20, 30, 40, 51 or 60)
			:;highestLevel : Integer - Appears to return the highest level in the battleground that will be joining (19, 29, 39, 49 or 60)

	----		----
	~~;''Returns''~~

	:status, ~~mapName, instanceID~~		=== Details ===
	~~:;status : String - The~~ player~~'s Battlefield~~ status ~~('none', '~~queued~~', '~~confirm'~~, '~~active~~', 'error')~~
	~~:;mapName : String~~ - ~~The queued Battlefield's name ('Alterac Valley'~~, ~~etc.)~~		Used for retrieving the status of the battlegrounds that the player is queued or inside of, if the player is not queued for all 3 battlegrounds at once then passing an index higher then they are queued for will return none for status and [[Eastern Kingdoms]] as a map name.
	~~:;instanceID : Integer~~ - ~~The number of the Battlefield instance~~
			==== Status ====
			* queued - Waiting for a battlefield to become ready
			* confirm - Ready to join a battlefield
			* active - You're inside an active battlefield
			* none - Invalid index passed, not in queue for anything
			* error - This should never happen

			----
			=== Example ===
			Auto join a battlefield as soon as it's ready to enter

	for i=1, MAX_BATTLEFIELD_QUEUES do		for i=1, MAX_BATTLEFIELD_QUEUES do
	status, mapName, instanceID = GetBattlefieldStatus(i);		status, mapName, instanceID = GetBattlefieldStatus(i);
	if ( ~~instanceID ~~~= 0 ) then		if( status == "confirm" ) then
	~~mapName = mapName.." "..instanceID~~;		AcceptBattlefieldPort( i, true );
	end		end
	~~...~~

	----		----
	{{~~WoW API~~}}		{{wowapi}}