https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AGetLiveEventDataAPI:GetLiveEventData - Revision history2026-10-17T16:47:53ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:GetLiveEventData&diff=30420&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:44:18Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=LiveEvent}}<br />
Returns the texts, picture and sound of a live event.<br />
<br />
<pre><br />
eventData = GetLiveEventData(eventId)<br />
</pre><br />
<br />
== Arguments ==<br />
;eventId : <code>number</code> – Event id, as in [[API:GetLiveEventList|GetLiveEventList]].<br />
<br />
== Returns ==<br />
;eventData : <code>table</code> – The event's data, or nothing if the event is unknown or inactive.<br />
<br />
{| class="wikitable"<br />
! Key !! Type !! Meaning<br />
|-<br />
| <code>title</code> || <code>wstring</code> || Event title.<br />
|-<br />
| <code>subTitle</code> || <code>wstring</code> || Subtitle.<br />
|-<br />
| <code>description</code> || <code>wstring</code> || Summary text.<br />
|-<br />
| <code>loreText</code> || <code>wstring</code> || Lore text.<br />
|-<br />
| <code>textureName</code> || <code>string</code> || Name of the event's picture texture. The stock UI passes it to <code>DynamicImageSetTexture</code>.<br />
|-<br />
| <code>soundId</code> || <code>number</code> || Sound to play for the event; <code>0</code> for none. The stock UI plays it with <code>Sound.Play</code>.<br />
|}<br />
<br />
== Details ==<br />
* The table has no <code>id</code> field.<br />
* Exactly one argument must be passed.<br />
<br />
== Errors ==<br />
These are written to the UI log, and the function returns nothing.<br />
* <code>Error in function call 'GetLiveEventData': Event %d not found.</code> (also for an event that exists but is inactive)<br />
<br />
== Example ==<br />
From <code>default/ea_tomeofknowledge/source/tomewindow_liveevent.lua</code>:<br />
<pre><br />
local eventData = GetLiveEventData( TomeWindow.CurrentLiveEventId )<br />
...<br />
LabelSetText( PARENT_WINDOW.."Title", wstring.upper( eventData.title ) )<br />
LabelSetText( PARENT_WINDOW.."SubTitle", eventData.subTitle )<br />
LabelSetText( PARENT_WINDOW.."SummaryText", eventData.description )<br />
LabelSetText( PARENT_WINDOW.."LoreText", eventData.loreText )<br />
...<br />
DynamicImageSetTexture( PARENT_WINDOW.."Image", eventData.textureName, 0, 0)<br />
</pre><br />
<br />
== See also ==<br />
* [[API:GetLiveEventList|GetLiveEventList]]<br />
* [[API:GetLiveEventTasks|GetLiveEventTasks]]</div>Maintenance script