Skip to content
everloot

Lore archive · Warcraft Wiki, 2023 dump

API GetBattlefieldStatus

Last wiki revision 2022-08-01

Returns the status of the battlefield the player is either queued for or inside. status, mapName, teamSize, registeredMatch, suspendedQueue, queueType, gameType, role, asGroup, shortDescription, longDescription = GetBattlefieldStatus(index)

  • index: - Index of the battlefield you wish to view, in the range of 1 to GetMaxBattlefieldID
  • status: - Battlefield status, one of:
  • queued - Waiting for a battlefield to become ready, you're in the queue
  • confirm - Ready to join a battlefield
  • active - Inside an active battlefield
  • none - Not queued for anything in this index
  • error - This should never happen
  • mapName: - Localized name of the battlefield (eg. Warsong Gulch or Blade's Edge Arena)
  • teamSize: - Team size of the battlefields queue (2, 3 or 5 in an arena queue, or 0 in other queue types)
  • registeredMatch: - 1 in a registered arena queue, or 0 in a skirimish or non-arena queue; use teamSize to check for arenas.
  • suspendedQueue: - (used to determine whether the eye icon on the LFG minimap button should animate, presumed boolean or 1/nil)
  • queueType: - The type of battleground, one of:
  • ARENA
  • BATTLEGROUND
  • WARGAME
  • gameType: - ??? (displayed as-is to the user on the queue ready dialog, so presumed localized; can be an empty string)
  • role: - The role assigned to the player (TANK, DAMAGER, HEALER) in a non-rated battleground, or nil for other queue types.
  • asGroup:
  • shortDescription:
  • longDescription:

Source

https://warcraft.wiki.gg/wiki/API_GetBattlefieldStatus · retrieved 2023-11-13 · CC BY-SA 4.0

Converted from wikitext with templates, tables and images removed, so some sentences may be missing values.

This archive predates WoW: Forever. For collected gameplay facts see the Forever database. Search the archive.