https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3ALCDRegisterEventHandlerAPI:LCDRegisterEventHandler - Revision history2026-10-24T17:26:53ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:LCDRegisterEventHandler&diff=30538&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:46:11Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=LCD}}<br />
Registers a Lua function that an LCD page calls when a game event fires.<br />
<br />
<pre><br />
LCDRegisterEventHandler(pageName, eventId, callbackName)<br />
</pre><br />
<br />
== Arguments ==<br />
;pageName : <code>string</code> – Name of the page.<br />
;eventId : <code>number</code> – The event, a <code>SystemData.Events</code> value.<br />
;callbackName : <code>string</code> – Name of the Lua function to call, for example <code>"EA_LCDKeyboard.UpdateHP"</code>.<br />
<br />
== Returns ==<br />
Nothing.<br />
<br />
== Details ==<br />
* Each page can have one handler per event. If the page already has a handler for this event, the error below is logged and the old handler stays.<br />
* Input events (event ids 4 to 21) are not accepted for LCD pages. For those the client logs <code>Warning: LCD pages (%s) do not handle input events, so the %s callback %s() will never be executed.</code><br />
* The handler receives the event's normal arguments. The stock handler for <code>CHARACTER_QUEUE_UPDATED</code> is declared as <code>UpdateServerQueueStatus(waitSeconds, queuePos, queueSize)</code>.<br />
* Remove a handler with [[API:LCDUnregisterEventHandler|LCDUnregisterEventHandler]].<br />
* The function needs at least three arguments and only reads the last three.<br />
<br />
== Errors ==<br />
* <code>Error in function call 'LCDRegisterEventHandler': Page '%s' does not exist.</code><br />
* <code>Error in function call 'LCDRegisterEventHandler': Page %s already has an event handler (%s) for event %d.</code><br />
<br />
== Example ==<br />
From <code>ea_lcdkeyboard/source/g15test.lua</code>:<br />
<pre><br />
LCDRegisterEventHandler( EA_LCDKeyboard.Page1, SystemData.Events.PLAYER_CUR_HIT_POINTS_UPDATED, "EA_LCDKeyboard.UpdateHP" )<br />
LCDRegisterEventHandler( EA_LCDKeyboard.Page1, SystemData.Events.PLAYER_CUR_ACTION_POINTS_UPDATED, "EA_LCDKeyboard.UpdateAP" )<br />
LCDRegisterEventHandler( EA_LCDKeyboard.Page1, SystemData.Events.PLAYER_CAREER_RESOURCE_UPDATED, "EA_LCDKeyboard.UpdateCareerPoints" )<br />
</pre><br />
<br />
== See also ==<br />
* [[API:LCDUnregisterEventHandler|LCDUnregisterEventHandler]]<br />
* [[API:LCDSetButtonHandler|LCDSetButtonHandler]]<br />
* [[API:RegisterEventHandler|RegisterEventHandler]]</div>Maintenance script