Returns information about an active or queued battleground/arena instance
See also Battlefield functions.
Signature:
status,
mapName,
instanceID,
bracketMin,
bracketMax,
teamSize,
registeredMatch
=
GetBattlefieldStatus(index)
Arguments:
index
- Index of a battleground/arena queue the player has joined (between 1 andGetMaxBattlefieldID()
) (number
)
Returns:
status
- Status of the player with respect to the battleground (string
)active
- The player is currently playing in this battlegroundconfirm
- The player has been invited to enter this battleground but has not done so yetnone
- No battleground or queue at this indexqueued
- The player is queued for this battleground
mapName
- Name of the battleground (e.g. "Alterac Valley") or arena ("All Arenas" whilequeued
; "Eastern Kingdoms" regardless of destination while status isconfirm
, e.g. "Dalaran Sewers" whileactive
) (string
)instanceID
- If in a battleground or queued for a specific instance, the number identifying that instance (e.g. 13 in "Warsong Gulch 13"); otherwise 0 (number
)bracketMin
- Lowest level of characters in the player's level bracket for the battleground (number
)bracketMax
- Highest level of characters in the player's level bracket for the battleground (number
)teamSize
- Number of players per team for an arena match (number
)0
- Not an arena match2
- 2v2 Arena3
- 3v3 Arena5
- 5v5 Arena
registeredMatch
- 1 if a rated arena match; otherwise nil (1nil
)