https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3ACurrentEventsGetListAPI:CurrentEventsGetList - Revision history2026-10-19T18:02:16ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:CurrentEventsGetList&diff=30270&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:41:54Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=LiveEvent}}<br />
Returns the list of current world events last received from the server (the Current Events window).<br />
<br />
<pre><br />
events = CurrentEventsGetList()<br />
</pre><br />
<br />
== Arguments ==<br />
None.<br />
<br />
== Returns ==<br />
;events : <code>table</code> – Array of event tables, indexed from 1. Empty if there are no events. Nothing is returned if the current-events data is not available.<br />
<br />
Each event table:<br />
{| class="wikitable"<br />
! Key !! Type !! Meaning<br />
|-<br />
| <code>id</code> || <code>number</code> || Event id. Pass it to [[API:CurrentEventsJumpToEvent|CurrentEventsJumpToEvent]].<br />
|-<br />
| <code>type</code> || <code>number</code> || Event type. The stock UI compares it with <code>SystemData.CurrentEventType.PVE</code> and <code>SystemData.CurrentEventType.RVR</code>.<br />
|-<br />
| <code>subType</code> || <code>number</code> || Event subtype. The stock UI uses it as a key into <code>CurrentEvents.SubTypes</code> for the name, text and icon.<br />
|-<br />
| <code>subTypeId</code> || <code>number</code> || –<br />
|-<br />
| <code>tier</code> || <code>number</code> || Tier of the event (0–255). The stock UI groups events by tier 1–4.<br />
|-<br />
| <code>zone</code> || <code>number</code> || –<br />
|-<br />
| <code>time</code> || <code>number</code> || – (not a whole number in general; the stock UI's code that formats it as a time is commented out).<br />
|}<br />
<br />
== Details ==<br />
* Each call builds a new table from the client's stored list. To refresh the stored list from the server, call [[API:CurrentEventsUpdate|CurrentEventsUpdate]].<br />
* The stock UI uses the same function, <code>EA_Window_CurrentEvents.OnEventsUpdated</code>, to handle this function's result and the <code>SystemData.Events.CURRENT_EVENTS_LIST_UPDATED</code> event.<br />
<br />
== Errors ==<br />
None.<br />
<br />
== Example ==<br />
From <code>default/ea_overheadmapwindow/source/overheadmapwindow.lua</code>:<br />
<pre><br />
EA_Window_OverheadMap.OnEventsUpdated( CurrentEventsGetList() )<br />
...<br />
WindowSetShowing( "EA_Window_OverheadCurrentEventsButton", #eventsData > 0 )<br />
</pre><br />
<br />
From <code>default/ea_currenteventswindow/source/currenteventswindow.lua</code>:<br />
<pre><br />
for _, data in ipairs( eventsData )<br />
do<br />
if( data.type == SystemData.CurrentEventType.PVE )<br />
then<br />
local insertationIndex = GetTableIndexBasedOnPriority( m_eventsData[ data.tier ].PVE, data, "pvePriority", 1 )<br />
table.insert( m_eventsData[ data.tier ].PVE, insertationIndex, data )<br />
...<br />
</pre><br />
<br />
== See also ==<br />
* [[API:CurrentEventsUpdate|CurrentEventsUpdate]]<br />
* [[API:CurrentEventsJumpToEvent|CurrentEventsJumpToEvent]]<br />
* [[API:CurrentEventsGetTimers|CurrentEventsGetTimers]]</div>Maintenance script