Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:40:16Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Bindings}}
Binds a key or button combination to a keyboard action.

<pre>
AddBinding(action, deviceId, buttons)
</pre>

== Arguments ==
;action : <code>string</code> – Name of the action, as used by the key mapping window (the <code>action</code> field of its action data).
;deviceId : <code>number</code> – Input device, one of the <code>SystemData.InputDevice</code> values (for example <code>SystemData.InputDevice.KEYBOARD</code> or <code>.MOUSE</code>).
;buttons : <code>number-table</code> – Array of button IDs on that device, starting at index 1. For a keyboard combination this holds the modifier keys and the main key.

== Returns ==
Nothing.

== Details ==
* If <code>action</code> is not a known action, nothing happens and no error is raised.
* If the action already has a binding with the same device and the same buttons in the same order, nothing happens.
* Otherwise the binding is added to the action's list of bindings. Existing bindings of the action are kept.
* A <code>deviceId</code> of <code>0</code> is treated as <code>1</code>.
* Entries equal to <code>65535</code> (0xFFFF) in <code>buttons</code> are skipped.
* When a binding is added, <code>SystemData.Events.KEYBINDINGS_UPDATED</code> is raised.
* The function needs at least three arguments and only reads the last three.

== Errors ==
None besides the generic ''Invalid Parameters'' message when an argument has the wrong type.

== Example ==
Replacing a binding in the key mapping window, from <code>default/ea_keymappingwindow/source/keymappingwindow.lua</code>:
<pre>
-- Remove the old binding
if( KeyMappingWindow.actionsData[ KeyMappingWindow.SelectedActionDataIndex ]["keys"..KeyMappingWindow.bindIndex].deviceId ~= 0 )
then
local boundKeyData = KeyMappingWindow.actionsData[ KeyMappingWindow.SelectedActionDataIndex ]["keys"..KeyMappingWindow.bindIndex]
RemoveBinding( action, boundKeyData.deviceId, boundKeyData.buttons)
end

-- Add the bindings
AddBinding( action, deviceId, buttons )
</pre>

== See also ==
* [[API:RemoveBinding|RemoveBinding]]
* [[API:RemoveAllBindings|RemoveAllBindings]]
* [[API:RestoreDefaultBindings|RestoreDefaultBindings]]

API:AddBinding - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)