WoW:API GetBattlefieldInfo: Difference between revisions

← Older edit

WoW:API GetBattlefieldInfo (source)

Revision as of 04:45, 15 August 2023

121 bytes added , 15 August 2023

m

Move page script moved page API GetBattlefieldInfo to WoW:API GetBattlefieldInfo without leaving a redirect

Anonymous user

Move page script

@@ 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 index seems unnecessary. Placing nothing in the parenthesis seems to return the same values when tried with 1, 2, 3...
-Returns arg1 - arg9
+:;arg1 : String - The name of the Battlefield you opened the window for.
-   arg1
+:;arg2 : String - The story text in the information for the Battlefield.
-    The name of the Battlefield you are in line for
+:;arg3 : Integer - The lowest level to join in the Battlegrounds.
-   arg2
+:;arg4 : Integer - The highest level to join in the Battlegrounds.
-    The story text in the information for the Battlefield.
+:;arg5 : Integer - Unknown. Returned -1 on test. Named in Blizzard code as mapID.
-   arg3
+:;arg6 : Unknown - Returned 0. Named in Blizzard code as mapX.
-    The lowest level to join in the Battlegrounds.
+:;arg7 : Unknown - Returned 0. Named in Blizzard code as mapY.
-   arg4
+:;arg8 : Integer - Lowest level for the instance you will be joining (eg: in [[Warsong Gulch]], lvl40-49 game, returns 40).
-    The highest level to join in the Battlegrounds.
+:;arg9 : Integer - Highest level for the instance you will be joining.
-   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, lvl41-50 game, returns 41)
-   arg9
-    Highest level for the instance you will be joining. (see note above)
-[[Category:API Functions|GetBattlefieldInfo]]
+=== Details ===
-[[Category:API Battlefield Functions|GetBattlefieldInfo]]
+: 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.