GetBattlegroundInfo

Main Menu
WoW API Widget API Widget scripts Lua API Events CVars XML schema Macro commands Combat Log Escape sequences API changes HOWTOs Snippets UI tech. Category nav.

→ API by Alphabet

→ API Overview

Returns information about a battleground type.

name, canEnter, isHoliday, isRandom, battleGroundID, info = GetBattlegroundInfo(index)

Arguments

index 

Number: battleground type index, 1 to GetNumBattlegroundTypes().

Returns

name 

String - Localized battleground name.

canEnter 

Flag - 1 if the player can queue for this battleground, nil otherwise.

isHoliday 

Flag - 1 if this battleground is currently granting bonus honor due to a battleground holiday, nil otherwise.

isRandom 

Flag - 1 if this battleground is the random

battleGroundID 

Number - the ID associated with the Battleground ( 1 for Alterac Valley, 2 for Warsong Gulch, 3 for Arathi Basin, 7 for Eye of the Storm, 9 for Strand of the Ancients, 30 for Isle of Conquest, 32 for the random, 108 for Twin Peaks and 120 for The Battle for Gilneas)

info 

String - Localized information about the battleground (for the random battleground it returns the string of Alterac).