m
Move page script moved page API GetWorldPVPAreaInfo to WoW:API GetWorldPVPAreaInfo without leaving a redirect
(boilerplate) |
m (Move page script moved page API GetWorldPVPAreaInfo to WoW:API GetWorldPVPAreaInfo without leaving a redirect) |
||
| (4 intermediate revisions by 4 users not shown) | |||
| Line 2: | Line 2: | ||
Get information regarding a world PvP zone (e.g. Wintergrasp or Tol Barad). | Get information regarding a world PvP zone (e.g. Wintergrasp or Tol Barad). | ||
pvpID, localizedName, isActive, canQueue, startTime, canEnter = GetWorldPVPAreaInfo( | pvpID, localizedName, isActive, canQueue, startTime, canEnter = GetWorldPVPAreaInfo(index) | ||
== Arguments == | == Arguments == | ||
; | ;index : Number - the zone's index, from 1 to {{api|GetNumWorldPVPAreas}}() | ||
== Returns == | == Returns == | ||
:pvpID, localizedName, isActive, canQueue, startTime, canEnter | :pvpID, localizedName, isActive, canQueue, startTime, canEnter | ||
;pvpID : Number - the zone | ;pvpID : Number - ID number of the zone assigned by Blizzard. (see "Details" below) | ||
;localizedName : String - the zone's name, in the current locale | ;localizedName : String - the zone's name, in the current locale (e.g. Wintergrasp or Tol Barad) | ||
;isActive : Boolean - whether a battle is currently taking place in the zone | ;isActive : Boolean - whether a battle is currently taking place in the zone | ||
;canQueue : Boolean - whether players can currently queue for the next or current battle | ;canQueue : Boolean - whether players can currently queue for the next or current battle | ||
| Line 18: | Line 18: | ||
== Example == | == Example == | ||
local _, localizedName, | local _, localizedName, isActive, canQueue, startTime, canEnter = GetWorldPVPAreaInfo(2) | ||
if | if isActive then | ||
print(" | if canEnter and canQueue then | ||
print("Get over to " .. localizedName .. ", quick!") | |||
else | |||
print("They're fighting over in " .. localizedName .. ". Don't you wish you could join in?") | |||
end | |||
else | else | ||
print(" | print("Cool your jets, " .. localizedName .. " doesn't start for another " .. SecondsToTime(startTime) .. ".") | ||
end | end | ||
| Line 39: | Line 41: | ||
== Details == | == Details == | ||
: | Notes: | ||
: The "startTime" is always greater than 0. Once a battle begins, the "startTime" will be the number of seconds until the NEXT battle begins. | |||
: The return value pvpID does not equal the passed value of "index". There are currently (09FEB2011) only two zones - | |||
::Index #1 = Wintergrasp with pvpID = 1 | |||
::Index #2 = Tol Barad with pvpID = 2 | |||