WoW:API GetBattlefieldInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
m (Move page script moved page API GetBattlefieldInfo to API GetBattlefieldInfo without leaving a redirect)
 
(3 intermediate revisions by 3 users not shown)
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.
{{wowapi}}
GetBattlefieldInfo()


Usage:
=== Returns ===
GetBattlefieldInfo(index)
: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 : String - The name of the Battlefield you opened the window 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. Named in Blizzard code as mapID.
:;arg6 : Unknown - Returned 0. Named in Blizzard code as mapX.
:;arg7 : Unknown - Returned 0. Named in Blizzard code as mapY.
:;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.


;Returns arg1 - arg9:
=== Details ===
;arg1 : The name of the Battlefield you are in queue for
: 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.
;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.
 
 
----
{{WoW API}}

Latest revision as of 04:45, 15 August 2023

Returns information for the last Battlefield queue window you viewed.

← WoW API < GetBattlefieldInfo 

GetBattlefieldInfo()

Returns

arg1 - arg9
arg1
String - The name of the Battlefield you opened the window 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. Named in Blizzard code as mapID.
arg6
Unknown - Returned 0. Named in Blizzard code as mapX.
arg7
Unknown - Returned 0. Named in Blizzard code as mapY.
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.
Retrieved from "https://addonstudio.org/mw1/index.php?title=WoW:API_GetBattlefieldInfo&oldid=12240"