Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:40:35Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Interface}}
Raises a UI event. The event is queued and delivered to all listeners during the next interface update.

<pre>
BroadcastEvent(eventId)
</pre>

== Arguments ==
;eventId : <code>number</code> – Id of the event, usually a value from <code>SystemData.Events</code>.

== Returns ==
Nothing.

== Details ==
* The event is not delivered during the call. The id is added to a queue that the client empties during its next interface update.
* When the queue is emptied, each event is delivered to everything that listens for that id: functions registered with [[API:RegisterEventHandler|RegisterEventHandler]], windows that registered with <code>WindowRegisterEventHandler</code>, and the client's own listeners. The stock UI relies on the last group to request actions, for example <code>BroadcastEvent( SystemData.Events.QUIT )</code> or <code>BroadcastEvent( SystemData.Events.RELOAD_INTERFACE )</code>.
* Handlers are called without arguments.
* Events raised by a handler while the queue is being emptied are delivered in the same update, after the events already queued.
* The same id queued several times in a row is delivered only once. For example, three <code>BroadcastEvent( SystemData.Events.USER_SETTINGS_CHANGED )</code> calls in a row within one frame produce a single delivery.
* Event id 0 is never delivered.
* The function takes exactly one argument.

== Errors ==
None besides the ''Invalid Parameters'' argument check.

== Example ==
Telling the rest of the UI that settings have changed, from <code>ea_backpackwindow/source/backpackutils.lua</code>:
<pre>
BroadcastEvent( SystemData.Events.USER_SETTINGS_CHANGED )
</pre>

From <code>ea_uimodwindow/source/uimodwindow.lua</code>, after enabling or disabling modules:
<pre>
for index, modData in ipairs( UiModWindow.modsListData ) do
ModuleSetEnabled( modData.name, modData.isEnabled )
end

BroadcastEvent( SystemData.Events.RELOAD_INTERFACE )
</pre>

== See also ==
* [[API:RegisterEventHandler|RegisterEventHandler]]
* [[API:UnregisterEventHandler|UnregisterEventHandler]]
* [[API:WindowRegisterEventHandler|WindowRegisterEventHandler]]

API:BroadcastEvent - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)