https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AGetZoneObjectivesDataAPI:GetZoneObjectivesData - Revision history2026-10-17T16:47:34ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:GetZoneObjectivesData&diff=30491&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:45:25Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=RvR}}<br />
Returns the battlefield objectives of a campaign zone with their map positions and timers.<br />
<br />
<pre><br />
objectives = GetZoneObjectivesData(zoneId)<br />
</pre><br />
<br />
== Arguments ==<br />
;zoneId : <code>number</code> – Zone id, for example <code>GameData.Player.zone</code>.<br />
<br />
== Returns ==<br />
;objectives : <code>table</code> – Array of objective tables, indexed from 1, or nothing (see Details).<br />
<br />
Each objective table has these fields:<br />
{| class="wikitable"<br />
! Key !! Type !! Meaning<br />
|-<br />
| <code>objId</code> || <code>number</code> || Objective id.<br />
|-<br />
| <code>objMapTimer</code> || <code>number</code> || Timer value of the objective (may be fractional). The stock UI formats it with <code>TimeUtils.FormatClock</code>. <code>-1</code> if the client has no data for this objective. The stock UI hides the timer when it is not greater than 0.<br />
|-<br />
| <code>objPositionX</code> || <code>number</code> || X coordinate. The stock UI converts it with <code>MapGetPointForCoordinates</code>.<br />
|-<br />
| <code>objPositionY</code> || <code>number</code> || Y coordinate.<br />
|}<br />
<br />
== Details ==<br />
* The function returns nothing when the client has no campaign data at all (no error, argument not checked), or when the zone has no objective list.<br />
* A zone id that is not a campaign zone raises the error below.<br />
* A new table is built on every call.<br />
* The function takes exactly one argument.<br />
<br />
== Errors ==<br />
* <code>Error in function call 'GetZoneObjectivesData': Zone %d is not a valid campaign zone.</code><br />
<br />
== Example ==<br />
From <code>default/ea_rvrtracker/source/rvrtracker.lua</code>:<br />
<pre><br />
local objectivesData = GetZoneObjectivesData( GameData.Player.zone )<br />
if (objectivesData ~= nil)<br />
then<br />
for _, objectivePoint in ipairs(objectivesData)<br />
do<br />
EA_Window_RvRTracker.RefreshObjectiveTimer(objectivePoint.objId, objectivePoint.objMapTimer)<br />
end<br />
end<br />
</pre><br />
<br />
== See also ==<br />
* [[API:GetCampaignZoneData|GetCampaignZoneData]]<br />
* [[API:GameData.GetObjectiveData|GameData.GetObjectiveData]]<br />
* [[API:GetGameDataObjectives|GetGameDataObjectives]]</div>Maintenance script