WoW:API GetBattlefieldInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
mNo edit summary
m (formatting, other changes since 1.7)
Line 1: Line 1:
Returns information about the Battlefield when you are in the queue.
Returns information about the Battlefield when you are in the queue.


Usage
Usage:
GetBattlefieldInfo(index)
GetBattlefieldInfo(index)
  The index seems unnecessary. Placing nothing in the parenthesis seems to return the same values when tried with 1, 2, 3...


Returns arg1 - arg9
The following index seems unnecessary. Placing nothing in the parenthesis seems to return the same values when tried with 1, 2, 3...
  arg1
 
    The name of the Battlefield you are in line for
;Returns arg1 - arg9:
  arg2
;arg1 : The name of the Battlefield you are in queue for
    The story text in the information for the Battlefield.
;arg2 : The story text in the information for the Battlefield.
  arg3
;arg3 : The lowest level to join in the Battlegrounds.
    The lowest level to join in the Battlegrounds.
;arg4 : The highest level to join in the Battlegrounds.
  arg4
;arg5 : Unknown. Returned -1 on test.
    The highest level to join in the Battlegrounds.
;arg6 : Unknown. Returned 0.
  arg5
;arg7 : Unknown. Returned 0.
    Unknown. Returned -1 on test.
;arg8 : Lowest level for the instance you will be joining (eg: in [[Warsong Gulch]], lvl40-49 game, returns 40).
  arg6
;arg9 : Highest level for the instance you will be joining.
    Unknown. Returned 0.
  arg7
    Unknown. Returned 0.
  arg8
    Lowest level for the instance you will be joining (eg: in Warsong Gulch, lvl41-50 game, returns 41)
  arg9
    Highest level for the instance you will be joining. (see note above)


[[Category:API Functions|GetBattlefieldInfo]]
[[Category:API Functions|GetBattlefieldInfo]]
[[Category:API Battlefield Functions|GetBattlefieldInfo]]
[[Category:API Battlefield Functions|GetBattlefieldInfo]]

Revision as of 09:43, 25 September 2005

Returns information about the Battlefield when you are in the queue.

Usage:

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