https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AGetCampaignPairingDataAPI:GetCampaignPairingData - Revision history2026-10-17T15:21:42ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:GetCampaignPairingData&diff=30354&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:43:14Z<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 racial pairing: who controls it, which zone is contested, the fortress zones and the campaign timers.<br />
<br />
<pre><br />
pairingData = GetCampaignPairingData(pairingId)<br />
</pre><br />
<br />
== Arguments ==<br />
;pairingId : <code>number</code> – Pairing id, for example the <code>pairingId</code> from [[API:GetCampaignZoneData|GetCampaignZoneData]].<br />
<br />
== Returns ==<br />
;pairingData : <code>table</code> – Pairing table (see below), or nothing if the id is invalid.<br />
<br />
{| class="wikitable"<br />
! Key !! Type !! Meaning<br />
|-<br />
| <code>pairingId</code> || <code>number</code> || Pairing id.<br />
|-<br />
| <code>controllingRealm</code> || <code>number</code> || Realm that controls the pairing.<br />
|-<br />
| <code>contestedZone</code> || <code>number</code> || Zone id of the zone currently being fought over, or <code>0</code>. The stock UI uses <code>0</code> as "the battle is not in this pairing's zones".<br />
|-<br />
| <code>orderFortressZone</code> || <code>number</code> || Zone id of Order's fortress zone, or <code>0</code>.<br />
|-<br />
| <code>destructionFortressZone</code> || <code>number</code> || Zone id of Destruction's fortress zone, or <code>0</code>.<br />
|-<br />
| <code>isLocked</code> || <code>boolean</code> || <code>true</code> whenever <code>controllingRealm</code> is 1 or 2; see Details.<br />
|-<br />
| <code>fortressPQTimeRemaining</code> || <code>number</code> || – (may be fractional)<br />
|-<br />
| <code>captureTimeRemaining</code> || <code>number</code> || – (may be fractional)<br />
|}<br />
<br />
== Details ==<br />
* <code>isLocked</code> is not stored as such. It is <code>false</code> only when <code>controllingRealm</code> is neither 1 nor 2 and two further state values the client keeps for the pairing are both missing or below 2. In every other case it is <code>true</code>.<br />
* The two time values are stored as floats by the client and passed on unchanged.<br />
* When the client has no campaign data at all, the function returns nothing without an error.<br />
* The function takes exactly one argument.<br />
<br />
== Errors ==<br />
* <code>Error in function call 'GetCampaignPairingData': Paring %d is not a valid campaign pairing id.</code> (sic, "Paring")<br />
<br />
== Example ==<br />
From <code>default/ea_objectivetrackers/source/battlefieldobjectivetracker.lua</code>:<br />
<pre><br />
local pairingData = GetCampaignPairingData( zoneData.pairingId )<br />
if( pairingData.contestedZone ~= 0 )<br />
then<br />
-- The Battle is in annother zone in this pairing or in the city<br />
local frontLineZoneName = GetZoneName(pairingData.contestedZone)<br />
...<br />
else<br />
-- This pairing has been captured but a city is not yet unlocked<br />
local capturedRealmName = ( GetRealmName(pairingData.controllingRealm) )<br />
</pre><br />
<br />
== See also ==<br />
* [[API:GetCampaignZoneData|GetCampaignZoneData]]<br />
* [[API:GetCampaignCityData|GetCampaignCityData]]</div>Maintenance script