View source for API:GetLiveEventData

{{LuaApi|group=LiveEvent}}
Returns the texts, picture and sound of a live event.

<pre>
eventData = GetLiveEventData(eventId)
</pre>

== Arguments ==
;eventId : <code>number</code> – Event id, as in [[API:GetLiveEventList|GetLiveEventList]].

== Returns ==
;eventData : <code>table</code> – The event's data, or nothing if the event is unknown or inactive.

{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>title</code> || <code>wstring</code> || Event title.
|-
| <code>subTitle</code> || <code>wstring</code> || Subtitle.
|-
| <code>description</code> || <code>wstring</code> || Summary text.
|-
| <code>loreText</code> || <code>wstring</code> || Lore text.
|-
| <code>textureName</code> || <code>string</code> || Name of the event's picture texture. The stock UI passes it to <code>DynamicImageSetTexture</code>.
|-
| <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>.
|}

== Details ==
* The table has no <code>id</code> field.
* Exactly one argument must be passed.

== Errors ==
These are written to the UI log, and the function returns nothing.
* <code>Error in function call 'GetLiveEventData': Event %d not found.</code> (also for an event that exists but is inactive)

== Example ==
From <code>default/ea_tomeofknowledge/source/tomewindow_liveevent.lua</code>:
<pre>
local eventData = GetLiveEventData( TomeWindow.CurrentLiveEventId )
...
LabelSetText( PARENT_WINDOW.."Title", wstring.upper( eventData.title ) )
LabelSetText( PARENT_WINDOW.."SubTitle", eventData.subTitle )
LabelSetText( PARENT_WINDOW.."SummaryText", eventData.description )
LabelSetText( PARENT_WINDOW.."LoreText", eventData.loreText )
...
DynamicImageSetTexture( PARENT_WINDOW.."Image", eventData.textureName, 0, 0)
</pre>

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