WoW:API GetWorldPVPAreaInfo - Revision history

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

2023-08-15T04:46:36Z

Move page script moved page API GetWorldPVPAreaInfo to API GetWorldPVPAreaInfo without leaving a redirect

← Older revision

Revision as of 04:46, 15 August 2023

5.103.108.183: Fixed LUA example code

2016-01-27T01:50:02Z

Fixed LUA example code

← Older revision		Revision as of 01:50, 27 January 2016
Line 18:		Line 18:

	== Example ==		== Example ==
	local _, localizedName, _, canQueue, startTime, canEnter = GetWorldPVPAreaInfo(2)		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 " .. ~~name~~ .. ", quick!")		print("Get over to " .. localizedName .. ", quick!")
	else		else
	print("They're fighting over in " .. ~~name~~ .. ". Don't you wish you could join in?")		print("They're fighting over in " .. localizedName .. ". Don't you wish you could join in?")
	end		end
	else		else
	print("Cool your jets, " .. ~~name~~ .. " doesn't start for another " .. SecondsToTime(~~start~~) .. ".")		print("Cool your jets, " .. localizedName .. " doesn't start for another " .. SecondsToTime(startTime) .. ".")
	end		end

WoWWiki>Silvaner1: correct result to code

2011-07-21T22:31:21Z

correct result to code

← Older revision		Revision as of 22:31, 21 July 2011
Line 18:		Line 18:

	== Example ==		== Example ==
	local _, localizedName, _, canQueue, startTime, canEnter = GetWorldPVPAreaInfo(1)		local _, localizedName, _, canQueue, startTime, canEnter = GetWorldPVPAreaInfo(2)

	if isActive then		if isActive then

WoWWiki>Deleto: /* Details */

2011-02-12T13:39:27Z

Details

← Older revision		Revision as of 13:39, 12 February 2011
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 = ~~21.~~		::Index #2 = Tol Barad with pvpID = 2

WoWWiki>Draewind: 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.

2011-02-09T22:01:52Z

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.

← Older revision		Revision as of 22:01, 9 February 2011
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 20:		Line 20:
	local _, localizedName, _, canQueue, startTime, canEnter = GetWorldPVPAreaInfo(1)		local _, localizedName, _, canQueue, startTime, canEnter = GetWorldPVPAreaInfo(1)

	if ~~startTime > 0~~ then		if isActive then
			if canEnter and canQueue then
			print("Get over to " .. name .. ", quick!")
			else
			print("They're fighting over in " .. name .. ". Don't you wish you could join in?")
			end
			else
	print("Cool your jets, " .. name .. " doesn't start for another " .. SecondsToTime(start) .. ".")		print("Cool your jets, " .. name .. " doesn't start for another " .. SecondsToTime(start) .. ".")
	~~elif canEnter and canQueue then~~
	~~print("Get over to " .. name .. ", quick!")~~
	~~else~~
	~~print("They're fighting over in " .. name .. ". Don't you wish you could join in?")~~
	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 = 21.

WoWWiki>DarkRyder: boilerplate

2010-10-18T03:43:18Z

boilerplate

New page

{{wowapi}} __NOTOC__
Get information regarding a world PvP zone (e.g. Wintergrasp or Tol Barad).

pvpID, localizedName, isActive, canQueue, startTime, canEnter = GetWorldPVPAreaInfo(pvpID)

== Arguments ==
;pvpID : Number - the zone's index, from 1 to {{api|GetNumWorldPVPAreas}}()

== Returns ==
:pvpID, localizedName, isActive, canQueue, startTime, canEnter

;pvpID : Number - the zone's index, from 1 to {{api|GetNumWorldPVPAreas}}()
;localizedName : String - the zone's name, in the current locale
;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 ==
local _, localizedName, _, canQueue, startTime, canEnter = GetWorldPVPAreaInfo(1)

if startTime > 0 then
print("Cool your jets, " .. name .. " doesn't start for another " .. SecondsToTime(start) .. ".")
elif canEnter and canQueue then
print("Get over to " .. name .. ", quick!")
else
print("They're fighting over in " .. name .. ". Don't you wish you could join in?")
end

<big>'''Result'''</big>
-- 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 ==
: 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.