WoW:API GetWorldPVPAreaInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(boilerplate)
 
m (Move page script moved page API GetWorldPVPAreaInfo to 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)
  pvpID, localizedName, isActive, canQueue, startTime, canEnter = GetWorldPVPAreaInfo(index)


== Arguments ==
== Arguments ==
;pvpID : Number - the zone's index, from 1 to {{api|GetNumWorldPVPAreas}}()
;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's index, from 1 to {{api|GetNumWorldPVPAreas}}()
;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, _, canQueue, startTime, canEnter = GetWorldPVPAreaInfo(1)
  local _, localizedName, isActive, canQueue, startTime, canEnter = GetWorldPVPAreaInfo(2)
   
   
  if startTime > 0 then
  if isActive then
     print("Cool your jets, " .. name .. " doesn't start for another " .. SecondsToTime(start) .. ".")
     if canEnter and canQueue then
elif canEnter and canQueue then
          print("Get over to " .. localizedName .. ", quick!")
    print("Get over to " .. name .. ", quick!")
    else
          print("They're fighting over in " .. localizedName .. ".  Don't you wish you could join in?")
    end
  else
  else
     print("They're fighting over in " .. name .. ". Don't you wish you could join in?")
     print("Cool your jets, " .. localizedName .. " doesn't start for another " .. SecondsToTime(startTime) .. ".")
  end
  end


Line 39: Line 41:


== Details ==
== Details ==
: Note that there is some redundancy in the return values.  For example, the first return value is always the same as the argument passed and isActive will always be false when startTime is greater than 0.
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

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
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetWorldPVPAreaInfo&oldid=19381"