Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:43:11Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Game}}
Returns the display name of a key or button on an input device.

<pre>
name = GetButtonName(deviceId, buttonId)
</pre>

== Arguments ==
;deviceId : <code>number</code> – Input device, for example <code>SystemData.InputDevice.KEYBOARD</code>.
;buttonId : <code>number</code> – Button id on that device, as returned in the <code>buttons</code> array of [[API:GetBindingsForAction|GetBindingsForAction]]. <code>easystem_utils/source/keyutils.lua</code> lists some keyboard ids, for example 42 for left Shift.

== Returns ==
;name : <code>wstring</code> – Name of the button.

== Details ==
* Both numbers are converted to integers.
* The client first looks in its own table of button names. If the button is not there, it asks the input system for a name.
* The name is localised. <code>easystem_utils/source/keyutils.lua</code> notes that its short-name lookup table must be keyed with <code>GetButtonName</code> results for this reason.

== Errors ==
None.

== Example ==
From <code>easystem_utils/source/keyutils.lua</code>:
<pre>
local buttonName = GetButtonName( deviceId, buttonId )
</pre>

Building a lookup table of localised modifier names, from the same file:
<pre>
[GetButtonName(SystemData.InputDevice.KEYBOARD, LSHIFT)] = StringTables.ShortKeyNames.SHORTKEY_LEFT_SHIFT,
[GetButtonName(SystemData.InputDevice.KEYBOARD, LCTRL)] = StringTables.ShortKeyNames.SHORTKEY_LEFT_CONTROL,
</pre>

== See also ==
* [[API:GetBindingsForAction|GetBindingsForAction]]
* [[API:GetActionsForButtonCombination|GetActionsForButtonCombination]]

API:GetButtonName - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)