GetBattlefieldStatus
functionguessedavailable in: camelot
Returns the status of the battlefield the player is either queued for or inside.
The client has this function, but Blizzard's documentation leaves it out, so its parameters and results aren't known.
Parameters
| name | type | description |
|---|---|---|
index | number | Index of the battlefield you wish to view, in the range of 1 to GetMaxBattlefieldID() |
Returns
| # | name | type | description |
|---|---|---|---|
| 1 | status | string | Battlefield status, one of: |
| 2 | mapName | string? | Localized name of the battlefield (eg. Warsong Gulch or Blade's Edge Arena) |
| 3 | teamSize | number | Team size of the battlefields queue (2, 3 or 5 in an arena queue, or 0 in other queue types) |
| 4 | registeredMatch | boolean | true in a registered arena queue, or false in a skirimish or non-arena queue; use teamSize to check for arenas. |
| 5 | suspendedQueue | boolean? | (used to determine whether the eye icon on the LFG minimap button should animate, presumed boolean or 1/nil) |
| 6 | queueType | string? | The type of battleground, one of: |
| 7 | gameType | string? | ??? (displayed as-is to the user on the queue ready dialog, so presumed localized; can be an empty string) |
| 8 | role | string? | The role assigned to the player (TANK, DAMAGER, HEALER) in a non-rated battleground, or nil for other queue types. |
| 9 | asGroup | boolean? | |
| 10 | shortDescription | string? | |
| 11 | longDescription | string? | |
| 12 | isSoloQueue | boolean |
In wowlua's emulated client
guessedThe answer is worked out from Blizzard's documentation, its UI code and the function's name, and not checked against the client. what the statuses mean
sources
Description: warcraft.wiki.gg's API pages ↗, by its contributors, CC BY-SA 4.0 ↗.