WoW:API GetBattlefieldInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
(Formatting, also updated what it does to be accurate)
Line 1: Line 1:
Returns information about the Battlefield when you are in the queue.
Returns information for the last Battlefield queue window you viewed.


Usage:
  GetBattlefieldInfo()
  GetBattlefieldInfo(index)


The following index seems unnecessary. Placing nothing in the parenthesis seems to return the same values when tried with 1, 2, 3...
=== Returns ===
:arg1 - arg9


;Returns arg1 - arg9:
:;arg1 : String - The name of the Battlefield you are in queue for
;arg1 : The name of the Battlefield you are in queue for
:;arg2 : String - The story text in the information for the Battlefield.
;arg2 : The story text in the information for the Battlefield.
:;arg3 : Integer - The lowest level to join in the Battlegrounds.
;arg3 : The lowest level to join in the Battlegrounds.
:;arg4 : Integer - The highest level to join in the Battlegrounds.
;arg4 : The highest level to join in the Battlegrounds.
:;arg5 : Integer - Unknown. Returned -1 on test.
;arg5 : Unknown. Returned -1 on test.
:;arg6 : Unknown - Returned 0.
;arg6 : Unknown. Returned 0.
:;arg7 : Unknown - Returned 0.
;arg7 : Unknown. Returned 0.
:;arg8 : Integer - Lowest level for the instance you will be joining (eg: in [[Warsong Gulch]], lvl40-49 game, returns 40).
;arg8 : Lowest level for the instance you will be joining (eg: in [[Warsong Gulch]], lvl40-49 game, returns 40).
:;arg9 : Integer - Highest level for the instance you will be joining.
;arg9 : Highest level for the instance you will be joining.


=== Details ===
: Appears to get the battleground info for the last battlefield window open, meaning if you just opened the [[Warsong Gulch]] queue window then this will return info for that battleground.


----
----
{{WoW API}}
{{wowapi}}

Revision as of 04:59, 12 July 2006

Returns information for the last Battlefield queue window you viewed.

GetBattlefieldInfo()

Returns

arg1 - arg9
arg1
String - The name of the Battlefield you are in queue for
arg2
String - The story text in the information for the Battlefield.
arg3
Integer - The lowest level to join in the Battlegrounds.
arg4
Integer - The highest level to join in the Battlegrounds.
arg5
Integer - Unknown. Returned -1 on test.
arg6
Unknown - Returned 0.
arg7
Unknown - Returned 0.
arg8
Integer - Lowest level for the instance you will be joining (eg: in Warsong Gulch, lvl40-49 game, returns 40).
arg9
Integer - Highest level for the instance you will be joining.

Details

Appears to get the battleground info for the last battlefield window open, meaning if you just opened the Warsong Gulch queue window then this will return info for that battleground.

WoW API < GetBattlefieldInfo