Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:51:04Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Interface}}
Removes an event handler that was added with [[API:RegisterEventHandler|RegisterEventHandler]].

<pre>
UnregisterEventHandler(eventId, functionName)
</pre>

== Arguments ==
;eventId : <code>number</code> – Id of the event the handler was registered for.
;functionName : <code>string</code> – The same function name that was passed to [[API:RegisterEventHandler|RegisterEventHandler]]. The comparison is exact and case-sensitive.

== Returns ==
Nothing.

== Details ==
* Only the handler for this event is removed. If the same function is registered for other events, those registrations stay.
* It is safe to call from inside a handler while the event is being delivered.
* The function needs at least two arguments and only reads the last two.

== Errors ==
These are written to the UI log; the call returns normally.
* <code>Error in function call 'UnregisterEventHandler': Invalid Event Id</code> (event id 0)
* <code>Error in function call 'UnregisterEventHandler': Invalid Script Name</code> (empty name)
* <code>Error in function call 'UnregisterEventHandler': Script %s is not registered for event #%d</code>

== Example ==
From <code>easystem_actionbarclustermanager/source/actionbarclustermanager.lua</code>:
<pre>
UnregisterEventHandler (SystemData.Events.PLAYER_CAREER_LINE_UPDATED, "ActionBarClusterManager.SpawnCluster")
UnregisterEventHandler (SystemData.Events.LOADING_END, "ActionBarClusterManager.SpawnCluster")
</pre>

== See also ==
* [[API:RegisterEventHandler|RegisterEventHandler]]
* [[API:BroadcastEvent|BroadcastEvent]]

API:UnregisterEventHandler - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)