Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:43:04Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Game}}
Returns every key or button combination bound to an action.

<pre>
bindings = GetBindingsForAction(actionName)
</pre>

== Arguments ==
;actionName : <code>string</code> – Name of the action. Compared without regard to case.

== Returns ==
;bindings : <code>table</code> – Array of binding tables, indexed from 1. Empty if the action has no bindings or the name is unknown.

Each binding table has these fields:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>deviceId</code> || <code>number</code> || Input device of the binding. Compare with <code>SystemData.InputDevice</code> values, for example <code>SystemData.InputDevice.KEYBOARD</code>.
|-
| <code>buttons</code> || <code>table</code> || Array of button ids (<code>number</code>) that make up the combination, indexed from 1.
|}

== Details ==
* An unknown action name returns an empty table. It is not an error.
* Pass <code>deviceId</code> and each button id to [[API:GetButtonName|GetButtonName]] to get a readable name.
* In the stock UI, all buttons before the last one in a combination are treated as keyboard modifiers (see the example).

== Errors ==
None.

== Example ==
From <code>KeyUtils.GetBindingsForAction</code> in <code>easystem_utils/source/keyutils.lua</code>:
<pre>
local boundKeys = GetBindingsForAction( action )
...
for bindingCount, bindingData in ipairs( boundKeys )
do
...
for buttonCount, buttonId in ipairs( bindingData.buttons )
do
local deviceId = bindingData.deviceId

-- Modifiers are always on the keyboard, so force the device id
-- on anything before the final button, so we can show things like shift-mouse3
if( numButtons ~= buttonCount )
then
deviceId = SystemData.InputDevice.KEYBOARD
end

local buttonName = GetButtonName( deviceId, buttonId )
...
</pre>

== See also ==
* [[API:GetButtonName|GetButtonName]]
* [[API:GetActionsForButtonCombination|GetActionsForButtonCombination]]
* [[API:GetActionIdFromName|GetActionIdFromName]]

API:GetBindingsForAction - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)