Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:44:20Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=LiveEvent}}
Returns the tasks of a live event, the player's progress, and the reward levels.

<pre>
tasks = GetLiveEventTasks(eventId)
</pre>

== Arguments ==
;eventId : <code>number</code> – Event id, as in [[API:GetLiveEventList|GetLiveEventList]].

== Returns ==
;tasks : <code>table</code> – Array of the event's top-level task tables (indexed from 1), plus the named fields below. Nothing is returned if the event is unknown or inactive.

Named fields of <code>tasks</code>:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>overallMaxValue</code> || <code>number</code> || –
|-
| <code>overallCurrentValue</code> || <code>number</code> || The player's overall progress. The stock UI compares it with the reward level thresholds.
|-
| <code>eligible</code> || <code>boolean</code> || Whether the player is eligible for the event rewards.
|-
| <code>rewards</code> || <code>table</code> || Array of reward levels (see below).
|}

Each task table (also used for <code>subtasks</code>):
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>taskId</code> || <code>number</code> || Task id.
|-
| <code>name</code> || <code>wstring</code> || Task name.
|-
| <code>maxValue</code> || <code>number</code> || Progress needed for the task.
|-
| <code>currentValue</code> || <code>number</code> || The player's progress on the task.
|-
| <code>isOnlyText</code> || <code>boolean</code> || –
|-
| <code>tooltipText</code> || <code>wstring</code> || Tooltip text.
|-
| <code>subtasks</code> || <code>table</code> || Array of child task tables with the same layout.
|-
| <code>textureName</code> || <code>string</code> || Only for tasks that have a picture: the texture name. Load the picture with [[API:SetLiveEventTaskImage|SetLiveEventTaskImage]] before using it.
|-
| <code>textureRightAlign</code> || <code>boolean</code> || Only for tasks that have a picture.
|}

Each reward level in <code>rewards</code>:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>threshold</code> || <code>number</code> || Overall progress needed for this level.
|-
| <code>items</code> || <code>table</code> || Array of [[API:GetInventoryItemData#Item data table|item data tables]] for the level's reward items.
|}

== Details ==
* The tasks are in the array part of the table, so loop over them with <code>ipairs</code>. The stock UI also checks <code>type(task) == "table"</code>.
* Exactly one argument must be passed.

== Errors ==
These are written to the UI log, and the function returns nothing.
* <code>Error in function call 'GetLiveEventTasks': Event %d not found.</code> (also for an event that exists but is inactive)

== Example ==
From <code>default/ea_tomeofknowledge/source/tomewindow_liveevent.lua</code>, finding the parent of a task:
<pre>
local tasksList = GetLiveEventTasks( eventId )
local function RecursiveHelper( currentTasksList, parentTaskId )
for _, task in ipairs( currentTasksList )
do
...
if ( task.taskId == taskId )
then
return true, parentTaskId
end

local didFind, foundParentTaskId = RecursiveHelper( task.subtasks, task.taskId )
...
</pre>

From the same file, the reward progress bar:
<pre>
levelPercent = ( LiveEventTasks.overallCurrentValue - lastLevelThreshold ) / ( LiveEventTasks.rewards[level].threshold - lastLevelThreshold )
</pre>

== See also ==
* [[API:SetLiveEventTaskImage|SetLiveEventTaskImage]]
* [[API:GetLiveEventData|GetLiveEventData]]
* [[API:SelectEventRewards|SelectEventRewards]]

API:GetLiveEventTasks - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)