Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:46:12Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=LCD}}
Registers a Lua function that an LCD page calls when one of the LCD's four soft buttons is pressed or released.

<pre>
LCDSetButtonHandler(pageName, callbackName)
</pre>

== Arguments ==
;pageName : <code>string</code> – Name of the page.
;callbackName : <code>string</code> – Name of the Lua function to call, for example <code>"EA_LCDKeyboard.HandleLCDButton"</code>.

== Returns ==
Nothing.

== Details ==
* The handler is called as <code>callback(button, down)</code>:
** <code>button</code> (<code>number</code>) – the soft button, 1 to 4.
** <code>down</code> (<code>boolean</code>) – <code>true</code> when the button is pressed, <code>false</code> when it is released.
* Each page can have one button handler. If the page already has one, the error below is logged and the old handler stays. Remove it first with [[API:LCDUnsetButtonHandler|LCDUnsetButtonHandler]].
* The function needs at least two arguments and only reads the last two.

== Errors ==
* <code>Error in function call 'LCDSetButtonHandler': Page '%s' does not exist.</code>
* <code>Error in function call 'LCDSetButtonHandler': Page %s already has an button press handler (%s).</code>

== Example ==
From <code>ea_lcdkeyboard/source/g15test.lua</code>, which gives every page the same handler:
<pre>
LCDSetButtonHandler( EA_LCDKeyboard.Page0, "EA_LCDKeyboard.HandleLCDButton" )
LCDSetButtonHandler( EA_LCDKeyboard.Page1, "EA_LCDKeyboard.HandleLCDButton" )

function EA_LCDKeyboard.HandleLCDButton(button, down)
if( down ) then
if( button == 1 ) then
LCDShowPage( EA_LCDKeyboard.Page1 )
end
-- ...
</pre>

== See also ==
* [[API:LCDUnsetButtonHandler|LCDUnsetButtonHandler]]
* [[API:LCDRegisterEventHandler|LCDRegisterEventHandler]]
* [[API:LCDShowPage|LCDShowPage]]

API:LCDSetButtonHandler - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)