v0.13.8

C_PvP.GetBattlegroundInfo

functionguessedavailable in: camelot

Returns information about a battleground in the battleground list, or nil when there is none at that index. · description by wowlua

signaturewowlua
function C_PvP.GetBattlegroundInfo(    battlegroundIndex: number): BattlegroundInfo?

Parameters

nametypedescription
battlegroundIndexnumberThe battleground's index in the list.

Returns

battlegroundInfo · BattlegroundInfo?

BattlegroundInfo
fieldtype
namestring
iconnumber?
gameTypestring
shortDescriptionstring
longDescriptionstring
mapDescriptionstring
maxPlayersnumber
battlegroundIDnumber?
lfgDungeonIDnumber?
mapIDnumber?
isHolidayboolean
isRandomboolean
canEnterboolean
isTrainingGroundboolean

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

Restrictions

sources

Signature and flags: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (PvpInfo system, camelot 1.60.1). Description: written by wowlua where no documentation describes the entry.