https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AGetCampaignZoneDataAPI:GetCampaignZoneData - Revision history2026-10-17T11:51:25ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:GetCampaignZoneData&diff=30355&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:43:15Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=RvR}}<br />
Returns the RvR campaign state of one zone: its tier, pairing, realms, lock state and control points.<br />
<br />
<pre><br />
zoneData = GetCampaignZoneData(zoneId)<br />
</pre><br />
<br />
== Arguments ==<br />
;zoneId : <code>number</code> – Zone id, for example <code>GameData.Player.zone</code>.<br />
<br />
== Returns ==<br />
;zoneData : <code>table</code> – Zone table (see below), or nothing if the zone is not a campaign zone.<br />
<br />
{| class="wikitable"<br />
! Key !! Type !! Meaning<br />
|-<br />
| <code>zoneId</code> || <code>number</code> || Zone id.<br />
|-<br />
| <code>tierId</code> || <code>number</code> || Tier of the zone. The client adds 1 to the stored value.<br />
|-<br />
| <code>pairingId</code> || <code>number</code> || Campaign pairing the zone belongs to. Pass it to [[API:GetCampaignPairingData|GetCampaignPairingData]].<br />
|-<br />
| <code>initialRealm</code> || <code>number</code> || –<br />
|-<br />
| <code>controllingRealm</code> || <code>number</code> || Realm that controls the zone.<br />
|-<br />
| <code>isLocked</code> || <code>boolean</code> || Whether the zone is locked.<br />
|-<br />
| <code>controlPoints</code> || <code>table</code> || Three numbers keyed <code>0</code>, <code>1</code> and <code>2</code>. The stock UI reads <code>controlPoints[GameData.Realm.ORDER]</code> and <code>controlPoints[GameData.Realm.DESTRUCTION]</code>.<br />
|}<br />
<br />
== Details ==<br />
* The function returns nothing when the client has no campaign data at all, or when <code>zoneId</code> is not one of its campaign zones. No error is raised in either case, unlike [[API:GetZoneObjectivesData|GetZoneObjectivesData]].<br />
* <code>controlPoints</code> starts at key <code>0</code>, so <code>ipairs</code> and <code>#</code> skip the first value.<br />
* A new table is built on every call.<br />
* The function takes exactly one argument.<br />
<br />
== Errors ==<br />
None besides the generic ''Invalid Parameters'' message when the argument is missing or not a number.<br />
<br />
== Example ==<br />
From <code>default/ea_objectivetrackers/source/battlefieldobjectivetracker.lua</code>:<br />
<pre><br />
local zoneData = GetCampaignZoneData( GameData.Player.zone )<br />
<br />
if( (zoneData ~= nil) and (zoneData.isLocked) )<br />
then<br />
local pairingData = GetCampaignPairingData( zoneData.pairingId )<br />
</pre><br />
<br />
Reading the control points, from <code>default/easystem_threepartbar/source/ea_threepartbar.lua</code>:<br />
<pre><br />
barData.leftValue = zoneData.controlPoints[ GameData.Realm.ORDER ]<br />
barData.rightValue = zoneData.controlPoints[ GameData.Realm.DESTRUCTION ]<br />
</pre><br />
<br />
== See also ==<br />
* [[API:GetCampaignPairingData|GetCampaignPairingData]]<br />
* [[API:GetZoneObjectivesData|GetZoneObjectivesData]]<br />
* [[API:GetZoneLargestHotspotSize|GetZoneLargestHotspotSize]]</div>Maintenance script