WoW API: JoinBattlefield

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

→ WoW API

← WoW API < JoinBattlefield

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

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.