WoW:API GetWorldPVPAreaInfo: Difference between revisions
Jump to navigation
Jump to search
(The redundancies listed are not accurate. The passed index value does not equal the return ID value. The start time in seconds equals the start of the following battle when the zone is active.) |
m (Move page script moved page API GetWorldPVPAreaInfo to API GetWorldPVPAreaInfo without leaving a redirect) |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 18: | Line 18: | ||
== Example == | == Example == | ||
local _, localizedName, | local _, localizedName, isActive, canQueue, startTime, canEnter = GetWorldPVPAreaInfo(2) | ||
if isActive then | if isActive then | ||
if canEnter and canQueue then | if canEnter and canQueue then | ||
print("Get over to " .. | print("Get over to " .. localizedName .. ", quick!") | ||
else | else | ||
print("They're fighting over in " .. | print("They're fighting over in " .. localizedName .. ". Don't you wish you could join in?") | ||
end | end | ||
else | else | ||
print("Cool your jets, " .. | print("Cool your jets, " .. localizedName .. " doesn't start for another " .. SecondsToTime(startTime) .. ".") | ||
end | end | ||
| Line 45: | Line 45: | ||
: The return value pvpID does not equal the passed value of "index". There are currently (09FEB2011) only two zones - | : 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 #1 = Wintergrasp with pvpID = 1 | ||
::Index #2 = Tol Barad with pvpID = | ::Index #2 = Tol Barad with pvpID = 2 | ||
Latest revision as of 04:46, 15 August 2023
← WoW API < GetWorldPVPAreaInfo
Get information regarding a world PvP zone (e.g. Wintergrasp or Tol Barad).
pvpID, localizedName, isActive, canQueue, startTime, canEnter = GetWorldPVPAreaInfo(index)
Arguments[edit]
- index
- Number - the zone's index, from 1 to GetNumWorldPVPAreas()
Returns[edit]
- pvpID, localizedName, isActive, canQueue, startTime, canEnter
- pvpID
- Number - ID number of the zone assigned by Blizzard. (see "Details" below)
- 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
- canQueue
- Boolean - whether players can currently queue for the next or current battle
- startTime
- Number - time until the next battle starts, in seconds
- canEnter
- Boolean - whether the player meets the necessary requirements to participate in the zone's battle
Example[edit]
local _, localizedName, isActive, canQueue, startTime, canEnter = GetWorldPVPAreaInfo(2)
if isActive then
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
print("Cool your jets, " .. localizedName .. " doesn't start for another " .. SecondsToTime(startTime) .. ".")
end
Result
-- if the battle hasn't started yet "Cool your jets, Tol Barad doesn't start for another 12:34."
-- if the battle is active and the player can join it "Get over to Tol Barad, quick!"
-- if the battle is active but the player cannot join "They're fighting over in Tol Barad. Don't you with you could join in?"
Details[edit]
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