WoW:API AcceptBattlefieldPort: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
mNo edit summary
m (Typing wiki entries at 2 AM is bad I guess.)
Line 9: Line 9:
:;index : Numeric - The battlefield in queue to enter.
:;index : Numeric - The battlefield in queue to enter.
:;accept : Boolean - Whether or not to accept entry to the battlefield.
:;accept : Boolean - Whether or not to accept entry to the battlefield.
=== Details ===
Passing nil as an accept argument will cause you to leave the queue for the battlefield, if you are inside a battlefield you will leave it regardless if it's ended or not.


=== Example ===
=== Example ===
Line 25: Line 28:
----
----
__NOTOC__
__NOTOC__
{{Template:WoW API}}
{{wowapi}}

Revision as of 18:02, 13 July 2006

AcceptBattlefieldPort() - Documentation by weab

Confirms entry into a Battleground you are queued for that is ready.

AcceptBattlefieldPort(index, accept)

Parameters

Arguments

index
Numeric - The battlefield in queue to enter.
accept
Boolean - Whether or not to accept entry to the battlefield.

Details

Passing nil as an accept argument will cause you to leave the queue for the battlefield, if you are inside a battlefield you will leave it regardless if it's ended or not.

Example

If the following code is called when the UPDATE_BATTLEFIELD_STATUS event is fired, it will automatically join a battleground when it becomes available.

for i=1, MAX_BATTLEFIELD_QUEUES do
	status, mapName, instanceID = GetBattlefieldStatus(i)
	if status == "confirm" then
		AcceptBattlefieldPort(i,1)
		StaticPopup_Hide("CONFIRM_BATTLEFIELD_ENTRY")
	end
end



WoW API < AcceptBattlefieldPort