WoW:API GetBattlegroundInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Created page with '{{wowapi}} Returns information about a battleground type. name, canEnter, isHoliday, minLevel = GetBattlegroundInfo(index); ==Arguments== ;index : Number: battleground type ind...')
 
No edit summary
Line 1: Line 1:
{{wowapi}}
{{wowapi}}
Returns information about a battleground type.
Returns information about a battleground type.
  name, canEnter, isHoliday, minLevel = GetBattlegroundInfo(index);
  local name, canEnter, isHoliday, isRandom, BattleGroundID = GetBattlegroundInfo(BGindex);


==Arguments==
==Arguments==
Line 10: Line 10:
;canEnter : Flag - 1 if the player can queue for this battleground, nil otherwise.
;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.
;isHoliday : Flag - 1 if this battleground is currently granting bonus honor due to a battleground holiday, nil otherwise.
;minLevel : Number - Minimum character level required to queue for this battleground.
;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, and 32 for the random)

Revision as of 00:41, 23 July 2010

WoW API < GetBattlegroundInfo

Returns information about a battleground type.

local name, canEnter, isHoliday, isRandom, BattleGroundID = GetBattlegroundInfo(BGindex);

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, and 32 for the random)