Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:42:54Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Game}}
Returns the objectives the player is currently tracking: public quests, battlefield objectives, keeps and city objectives.

<pre>
objectives = GetActiveObjectivesData()
</pre>

== Arguments ==
None.

== Returns ==
;objectives : <code>table</code> – Array of objective tables, indexed from 1.

Each objective table has these fields:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>id</code> || <code>number</code> || Objective id.
|-
| <code>name</code> || <code>wstring</code> || Objective name.
|-
| <code>controllingRealm</code> || <code>number</code> || Realm that holds the objective.
|-
| <code>curControlPoints</code> || <code>number</code> || — (may be negative)
|-
| <code>isCapturePoint</code> || <code>boolean</code> || —
|-
| <code>difficulty</code> || <code>number</code> || Difficulty, used by the stock UI for the tracker's difficulty text.
|-
| <code>isBattlefieldObjective</code> || <code>boolean</code> || —
|-
| <code>isKeep</code> || <code>boolean</code> || —
|-
| <code>isFortress</code> || <code>boolean</code> || —
|-
| <code>isPublicQuest</code> || <code>boolean</code> || <code>true</code> when none of the other type flags are set.
|-
| <code>isCityBoss</code> || <code>boolean</code> || —
|-
| <code>optedOutForLoot</code> || <code>number</code> || —
|-
| <code>forcedOutForLoot</code> || <code>boolean</code> || —
|-
| <code>Quest</code> || <code>table</code> || Array of the objective's quest stages, indexed from 1, at most 5 entries. See below.
|}

Each entry of <code>Quest</code>:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>influenceType</code> || <code>number</code> || Same value for every entry of one objective.
|-
| <code>name</code> || <code>wstring</code> || Stage name.
|-
| <code>desc</code> || <code>wstring</code> || Stage description.
|-
| <code>complete</code> || <code>boolean</code> || —
|-
| <code>timerName</code> || <code>wstring</code> || —
|-
| <code>timerValue</code> || <code>number</code> || —
|-
| <code>timerState</code> || <code>number</code> || —
|-
| <code>isTimeToComplete</code> || <code>boolean</code> || —
|-
| <code>availableRealm</code> || <code>number</code> || —
|-
| <code>conditions</code> || <code>table</code> || Array of conditions, indexed from 1. Each has <code>name</code> (<code>wstring</code>), <code>curCounter</code> (<code>number</code>), <code>maxCounter</code> (<code>number</code>) and <code>failureCondition</code> (<code>boolean</code>).
|}

== Details ==
* <code>isBattlefieldObjective</code>, <code>isKeep</code>, <code>isFortress</code> and <code>isCityBoss</code> come from separate bits of one type value. <code>isPublicQuest</code> is <code>true</code> only when that value is 0.
* A new table is built on every call. The stock UI stores it in <code>DataUtils.activeObjectivesData</code> and refreshes it from the objective tracker event handlers.
* Unlike most data getters, this function does not check for a player object.

== Errors ==
None.

== Example ==
From <code>easystem_utils/source/datautils.lua</code>:
<pre>
DataUtils.activeObjectivesData = GetActiveObjectivesData()
</pre>

Using the difficulty, from <code>ea_objectivetrackers/source/citytrackerwindow.lua</code>:
<pre>
local difficultyText = TrackerUtils.GetDifficultyText( objectiveData.difficulty )
</pre>

== See also ==
* [[API:GetAreaData|GetAreaData]]
* [[API:GetQuestData|GetQuestData]]

API:GetActiveObjectivesData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)