WoW:API GetBattlefieldStatus: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Slightly better example)
Line 1: Line 1:
{{wowapi}}
Get the status of the battlefield that the player is either queued for or inside.
Get the status of the battlefield that the player is either queued for or inside.


Line 24: Line 25:


Used for retrieving the status of the battlegrounds that the player is queued or inside of, if the player is not queued for all 3 battlegrounds at once then passing an index higher then they are queued for will return none for status and [[Eastern Kingdoms]] as a map name.
Used for retrieving the status of the battlegrounds that the player is queued or inside of, if the player is not queued for all 3 battlegrounds at once then passing an index higher then they are queued for will return none for status and [[Eastern Kingdoms]] as a map name.
Appears to return 0 for minlevel and maxlevel of Alterac Valley.


==== Status ====
==== Status ====
Line 34: Line 36:
----
----
=== Example ===
=== Example ===
Auto join a battlefield as soon as it's ready to enter
Display a list of battlefield brackets you're currently queued for, pending confirmation, in, or just finished.
 
  for i=1, MAX_BATTLEFIELD_QUEUES do
    status, mapName, instanceID = GetBattlefieldStatus(i);
    if( status == "confirm" ) then
      AcceptBattlefieldPort( i, true );
    end


----
local status, mapName, instanceID, minlevel, maxlevel;
{{wowapi}}
for i=1, MAX_BATTLEFIELD_QUEUES do
  status, mapName, instanceID, minlevel, maxlevel = GetBattlefieldStatus(i);
  DEFAULT_CHAT_FRAME:AddMessage(mapName .. string.format(" (%d-%d): ", minlevel, maxlevel) ..status);
end

Revision as of 14:57, 11 September 2006

← WoW API < GetBattlefieldStatus

Get the status of the battlefield that the player is either queued for or inside. 

status, mapName, instanceID = GetBattlefieldStatus(index);

Parameters

Arguments

index
Index of the battlefield you wish to view

Returns

status
String - Battlefield status (none, queued, confirm, active, error)
map
String - Localized battlefield name (Warsong Gulch, Arathi Basin, Alterac Valley or Eastern Kingdoms)
instanceID
Integer - Battlefield instance (returns 0 until you are inside an active battlefield)

(new in 1.12)

lowestLevel
Integer - Appears to return the lowest level in the battleground that will be joining (10, 20, 30, 40, 51 or 60)
highestLevel
Integer - Appears to return the highest level in the battleground that will be joining (19, 29, 39, 49 or 60)

Details

Used for retrieving the status of the battlegrounds that the player is queued or inside of, if the player is not queued for all 3 battlegrounds at once then passing an index higher then they are queued for will return none for status and Eastern Kingdoms as a map name. Appears to return 0 for minlevel and maxlevel of Alterac Valley.

Status

  • queued - Waiting for a battlefield to become ready
  • confirm - Ready to join a battlefield
  • active - You're inside an active battlefield
  • none - Invalid index passed, not in queue for anything
  • error - This should never happen

Example

Display a list of battlefield brackets you're currently queued for, pending confirmation, in, or just finished. 

local status, mapName, instanceID, minlevel, maxlevel;
for i=1, MAX_BATTLEFIELD_QUEUES do
 status, mapName, instanceID, minlevel, maxlevel = GetBattlefieldStatus(i);
 DEFAULT_CHAT_FRAME:AddMessage(mapName .. string.format(" (%d-%d): ", minlevel, maxlevel) ..status);
end
Retrieved from "https://addonstudio.org/mw1/index.php?title=WoW:API_GetBattlefieldStatus&oldid=12551"