API:GetLiveEventList

UI Lua API · LiveEvent functions
Version: WAR 1.4.8

Returns the live events (Tome of Knowledge "Live Event" section) that the client currently knows as active.

events = GetLiveEventList()

Arguments

None.

Returns

events: table – Array of event tables, indexed from 1. Empty if there are no active events.

Each event table:

Key	Type	Meaning
`id`	`number`	Event id. Pass it to GetLiveEventData and GetLiveEventTasks.
`title`	`wstring`	Event title.
`eligible`	`boolean`	Whether the player is eligible for the event. The stock UI can hide ineligible events.
`ended`	`boolean`	Whether the event has ended. The stock UI can hide ended events.

Details

Events that the client marks as inactive are left out. GetLiveEventData and GetLiveEventTasks reject inactive events in the same way.

Errors

None.

Example

From default/ea_tomeofknowledge/source/tomewindow_liveevent.lua:

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 ) )
    ...

Return of Reckoning