Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:48:04Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Bindings}}
Removes one key or button binding from a keyboard action.

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

== Arguments ==
;action : <code>string</code> – Name of the action.
;deviceId : <code>number</code> – Input device of the binding to remove (a <code>SystemData.InputDevice</code> value).
;buttons : <code>number-table</code> – Array of button IDs of the binding to remove, starting at index 1.

== Returns ==
Nothing.

== Details ==
* The binding is only removed when the action has a binding with exactly this device and these buttons, in the same order. Pass back the <code>deviceId</code> and <code>buttons</code> that were read from the binding, as the stock UI does.
* If <code>action</code> is not a known action, or no binding matches, nothing happens and no error is raised.
* Entries equal to <code>65535</code> (0xFFFF) in <code>buttons</code> are skipped.
* When a binding is removed, <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 ==
Clearing the shown bindings of an action, from <code>default/ea_keymappingwindow/source/keymappingwindow.lua</code>:
<pre>
for keyIndex=1, MAX_SHOWN_BINDINGS
do
local boundKeyData = KeyMappingWindow.actionsData[ actionIndex ]["keys"..keyIndex]
RemoveBinding( action, boundKeyData.deviceId, boundKeyData.buttons)
end
</pre>

== See also ==
* [[API:AddBinding|AddBinding]]
* [[API:RemoveAllBindings|RemoveAllBindings]]

API:RemoveBinding - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)