WoW:API JoinBattlefield - Revision history

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

2023-08-15T04:46:48Z

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

← Older revision

Revision as of 04:46, 15 August 2023

WoWWiki>Parl2001: /* Example */

2010-03-07T23:14:16Z

Example

← Older revision		Revision as of 23:14, 7 March 2010
Line 28:		Line 28:
	end		end
	end		end


			The following will queue you for Skirmish 2v2 if not in a group.

			/script JoinBattlefield(1)

	== Notes ==		== Notes ==

WoWWiki>Starlightblunder: /* Example */ + loud errors on serial calls.

2009-08-21T12:58:31Z

Example: + loud errors on serial calls.

← Older revision		Revision as of 12:58, 21 August 2009
Line 1:		Line 1:
	{{wowapi}}		{{wowapi}} __NOTOC__
	Queues the player, or the ~~players~~ group for a battlefield.		Queues the player, or the player's group, for a battlefield instance.
			JoinBattlefield(index[, asGroup[, isRated]])

	~~JoinBattlefield~~(~~index~~, ~~joinAs~~, isRated)		== Arguments ==
			;index : Number - Which battlefield instance to queue for (0 for first available), or which arena bracket to queue for.
			;asGroup : Boolean - If true-equivalent, the player's group is queued for the battlefield, otherwise, only the player is queued.
			;isRated : Boolean - If true-equivalent, and queueing for an arena bracket, the group is queued for a rated match as opposed to a skirmish.

	== ~~Parameters~~ ==		== Details ==
	~~=== Arguments ===~~		The function requests the player to be added to a queue for a particular instance of the currently selected battleground type, as set by {{api\|RequestBattlegroundInstanceInfo}}(index). You CANNOT queue immediately after a {{api\|RequestBattlegroundInstanceInfo}} call, and must instead capture the event that indicates that the instance list is available.
	:index, ~~joinAs, isRated~~

	~~:;index : Integer - Which battlefield instance to queue for (0 for first available), or which arena bracket to queue for~~		== Example ==
	~~:;joinAs : Integer - Queue as a group~~		The following code creates a utility function, JoinBattlegroundType, which allows you to queue for the first available instance of a specific battleground type.
	~~:;isRated : Integer - Queues for a rated arena~~		do
			local f, aG, iR = CreateFrame("FRAME");
	~~----~~		f:SetScript("OnEvent", function(self, event)
	==~~= Details =~~==		JoinBattlefield(0, aG, iR);
	~~Queues the player for the current battlefield they have open. When the Arena Battlemaster window is open~~, ~~index 1 is 2vs2~~, ~~index 2 is 3vs3 and index 3 is 5vs5, if~~ you ~~pass the "isRated" flag it'll~~ queue for a ~~rated arena, if you don't it'll queue for a Skirmish arena~~.		self:UnregisterEvent("PVPQUEUE_ANYWHERE_SHOW");
			end);
	~~[[Patch 2.0.3]] You can no longer queue a group for Alterac Valley~~, ~~and if the battlefield window is closed it won't queue you for the last opened battlefield. Because of this~~, ~~it's possible to do send a JoinBattlefield request and then not be queued if you jump away too quickly and close the window.~~		function JoinBattlegroundType(index, asGroup, isRated)
			if f:IsEventRegistered("PVPQUEUE_ANYWHERE_SHOW") then
	~~[[Patch 2.4.~~0~~]] Queuing for Alterac Valley as a group is back~~		error("A join battleground request is already being processed");
	~~----~~		end
			f:RegisterEvent("PVPQUEUE_ANYWHERE_SHOW");
	~~=== Example ===~~		aG, iR = asGroup, isRated;
	~~Queue the players group for the battlefield window open.~~		RequestBattlegroundInstanceInfo(index);
			end
	if( ~~CanJoinBattlefieldAsGroup~~() ~~) then~~
	~~-- Queue as a group for the first available battleground~~
	~~JoinBattlefield~~(~~0, 1~~);
	~~else~~
	~~-- Solo queue for the first available battleground~~
	~~JoinBattlefield~~(0);
	end		end


	~~Queue the players group for a rated 3vs3 arena.~~

	~~JoinBattlefield(2, 1, 1);~~

	~~Queue solo for 2v2 skirmish.~~

	~~/script JoinBattlefield(1, 0, 0)~~

	~~Queue solo for open BG window, make sure you see a little flash on your BG queue minimap icon or hear a little ding.~~

	~~/script JoinBattlefield(0)~~		== Notes ==
			* When the Arena Battlemaster window is open, index 1 is 2vs2, index 2 is 3vs3 and index 3 is 5vs5.

	~~__NOTOC__~~		== See Also ==
			* {{api\|CanJoinBattlefieldAsGroup}}

WoWWiki>Parl2001: /* Example */

2008-09-13T20:12:46Z

Example

← Older revision		Revision as of 20:12, 13 September 2008
Line 36:		Line 36:

	JoinBattlefield(2, 1, 1);		JoinBattlefield(2, 1, 1);

			Queue solo for 2v2 skirmish.

			/script JoinBattlefield(1, 0, 0)

			Queue solo for open BG window, make sure you see a little flash on your BG queue minimap icon or hear a little ding.

			/script JoinBattlefield(0)

	__NOTOC__		__NOTOC__

WoWWiki>Shadowed at 18:59, 12 March 2008

2008-03-12T18:59:50Z

← Older revision		Revision as of 18:59, 12 March 2008
Line 1:		Line 1:
	{{wowapi}}		{{wowapi}}
	Queues the player for a ~~battleground~~		Queues the player, or the players group for a battlefield.

	JoinBattlefield(index,joinAs)		JoinBattlefield(index, joinAs, isRated)

	== Parameters ==		== Parameters ==
	=== Arguments ===		=== Arguments ===
	:index, joinAs		:index, joinAs, isRated

	:;index : Integer - Which battlefield ~~index~~ to queue for ( 0 for ~~the~~ first available )		:;index : Integer - Which battlefield instance to queue for (0 for first available), or which arena bracket to queue for
	;:joinAs : Integer - Queue as a group ~~or queue solo ( nil for solo~~; 1 for ~~group )~~		:;joinAs : Integer - Queue as a group
			:;isRated : Integer - Queues for a rated arena

	----		----
	=== Details ===		=== Details ===
	~~Queue~~ the player for the current ~~battleground instance list~~ you ~~are viewing~~, if a window ~~isn~~'t opened it ~~will use~~ the ~~last one you had opened~~.		Queues the player for the current battlefield they have open. When the Arena Battlemaster window is open, index 1 is 2vs2, index 2 is 3vs3 and index 3 is 5vs5, if you pass the "isRated" flag it'll queue for a rated arena, if you don't it'll queue for a Skirmish arena.

			[[Patch 2.0.3]] You can no longer queue a group for Alterac Valley, and if the battlefield window is closed it won't queue you for the last opened battlefield. Because of this, it's possible to do send a JoinBattlefield request and then not be queued if you jump away too quickly and close the window.

			[[Patch 2.4.0]] Queuing for Alterac Valley as a group is back
	----		----

	=== Example ===		=== Example ===
	Queue ~~as a~~ group if the ~~battleground will allow it, which is currently everything except [[Alterac Valley]]~~.		Queue the players group for the battlefield window open.

	if( CanJoinBattlefieldAsGroup() ) then		if( CanJoinBattlefieldAsGroup() ) then
Line 26:		Line 31:
	JoinBattlefield(0);		JoinBattlefield(0);
	end		end


			Queue the players group for a rated 3vs3 arena.

	~~'''NOTE: As of~~ 2~~.0.3 you can no longer use this command to sign up your group for Alterac Valley'''~~		JoinBattlefield(2, 1, 1);

	__NOTOC__		__NOTOC__

WoWWiki>WoWWiki-Sarek: /* Example */

2007-01-12T19:10:04Z

Example

← Older revision		Revision as of 19:10, 12 January 2007
Line 27:		Line 27:
	end		end

	''~~Note~~: ~~JoinBattlefield(~~0~~, 1) will indeed queue the full~~ group for ~~AV, but not strictly as a group - it will behave similarly as if everybody had individually queued. It~~'~~s not clear if this is the intended effect.~~''		'''NOTE: As of 2.0.3 you can no longer use this command to sign up your group for Alterac Valley'''

	__NOTOC__		__NOTOC__

WoWWiki>Pinedae: /* Example */

2007-01-05T04:53:32Z

Example

← Older revision		Revision as of 04:53, 5 January 2007
Line 27:		Line 27:
	end		end

	''Note: JoinBattlefield(0, 1) ~~when the most recent BG talked to was AV~~ will indeed queue the full group for AV, but not strictly as a group - it will behave similarly as if everybody had individually queued. It's not clear if this is the intended effect.''		''Note: JoinBattlefield(0, 1) will indeed queue the full group for AV, but not strictly as a group - it will behave similarly as if everybody had individually queued. It's not clear if this is the intended effect.''

	__NOTOC__		__NOTOC__

WoWWiki>Sabelaide: /* Example */

2006-12-23T09:36:56Z

Example

← Older revision		Revision as of 09:36, 23 December 2006
Line 26:		Line 26:
	JoinBattlefield(0);		JoinBattlefield(0);
	end		end

			''Note: JoinBattlefield(0, 1) when the most recent BG talked to was AV will indeed queue the full group for AV, but not strictly as a group - it will behave similarly as if everybody had individually queued. It's not clear if this is the intended effect.''

	__NOTOC__		__NOTOC__

WoWWiki>Tmandry: Moved {{wowapi}} to the top where it should be

2006-08-26T15:37:24Z

Moved {{wowapi}} to the top where it should be

← Older revision		Revision as of 15:37, 26 August 2006
Line 1:		Line 1:
			{{wowapi}}
	Queues the player for a battleground		Queues the player for a battleground

Line 27:		Line 28:

	__NOTOC__		__NOTOC__
	~~{{wowapi}}~~

WoWWiki>Shadowed at 18:00, 12 July 2006

2006-07-12T18:00:03Z

New page

Queues the player for a battleground

JoinBattlefield(index,joinAs)

== Parameters ==
=== Arguments ===
:index, joinAs

:;index : Integer - Which battlefield index to queue for ( 0 for the first available )
;:joinAs : Integer - Queue as a group or queue solo ( nil for solo; 1 for group )

----
=== Details ===
Queue the player for the current battleground instance list you are viewing, if a window isn't opened it will use the last one you had opened.

----
=== Example ===
Queue as a group if the battleground will allow it, which is currently everything except [[Alterac Valley]].

if( CanJoinBattlefieldAsGroup() ) then
-- Queue as a group for the first available battleground
JoinBattlefield(0, 1);
else
-- Solo queue for the first available battleground
JoinBattlefield(0);
end

__NOTOC__
{{wowapi}}