Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:49:07Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=LiveEvent}}
Loads the picture of a live event task, so that its <code>textureName</code> can be used as a texture.

<pre>
SetLiveEventTaskImage(eventId, taskId)
</pre>

== Arguments ==
;eventId : <code>number</code> – Event id.
;taskId : <code>number</code> – Task id, the <code>taskId</code> field from [[API:GetLiveEventTasks|GetLiveEventTasks]].

== Returns ==
Nothing.

== Details ==
* The image file is taken from <code>interface/InterfaceCore/Tome/LiveEvent/Images/</code> and registered under the task's <code>textureName</code>. Use that name with <code>DynamicImageSetTexture</code>, as the stock UI does.
* Each task's picture is loaded only once; later calls for the same task do nothing. Tasks without a picture are ignored without an error.
* The function needs at least two arguments and only reads the last two.

== Errors ==
These are written to the UI log; the call returns normally.
* <code>Error in function call 'SetLiveEventTaskImage': Event %d not found.</code> (also for an event that exists but is inactive)
* <code>Error in function call 'SetLiveEventTaskImage': Task %d not found in event %ls.</code>
* <code>Error in function call 'SetLiveEventTaskImage': The specified image was not found for task %d in event %ls.</code>

== Example ==
From <code>default/ea_tomeofknowledge/source/tomewindow_liveevent.lua</code>:
<pre>
SetLiveEventTaskImage( TomeWindow.CurrentLiveEventId, task.taskId )
DynamicImageSetTexture( winName, task.textureName, 0, 0)
</pre>

== See also ==
* [[API:GetLiveEventTasks|GetLiveEventTasks]]
* [[API:GetLiveEventData|GetLiveEventData]]

API:SetLiveEventTaskImage - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)