Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:44:19Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=LiveEvent}}
Returns the live events (Tome of Knowledge "Live Event" section) that the client currently knows as active.

<pre>
events = GetLiveEventList()
</pre>

== Arguments ==
None.

== Returns ==
;events : <code>table</code> – Array of event tables, indexed from 1. Empty if there are no active events.

Each event table:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>id</code> || <code>number</code> || Event id. Pass it to [[API:GetLiveEventData|GetLiveEventData]] and [[API:GetLiveEventTasks|GetLiveEventTasks]].
|-
| <code>title</code> || <code>wstring</code> || Event title.
|-
| <code>eligible</code> || <code>boolean</code> || Whether the player is eligible for the event. The stock UI can hide ineligible events.
|-
| <code>ended</code> || <code>boolean</code> || Whether the event has ended. The stock UI can hide ended events.
|}

== Details ==
* Events that the client marks as inactive are left out. [[API:GetLiveEventData|GetLiveEventData]] and [[API:GetLiveEventTasks|GetLiveEventTasks]] reject inactive events in the same way.

== Errors ==
None.

== Example ==
From <code>default/ea_tomeofknowledge/source/tomewindow_liveevent.lua</code>:
<pre>
local function IsAnyLiveEventActive()
local liveEventList = GetLiveEventList()
return ( next(liveEventList) ~= nil )
end
...
local liveEventList = GetLiveEventList()
for _, event in ipairs(liveEventList)
do
if ( ShouldDisplayInEventList( event.ended, event.eligible ) )
...
</pre>

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

API:GetLiveEventList - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)