Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:51:53Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Window}}
Binds a window to a key-binding action, so that the action's key triggers the window.

<pre>
WindowSetGameActionTrigger(windowName, actionId)
</pre>

== Arguments ==
;windowName : <code>string</code> – Name of the window.
;actionId : <code>number</code> – Id of a key-binding action, for example from <code>GetActionIdFromName</code> or <code>SystemData.Settings.Keybindings.*.id</code>. 0 removes the binding.

== Returns ==
Nothing.

== Details ==
* Any action the window was bound to before is unbound first. With 0, no new binding is made.
* <code>actionId</code> is truncated to a whole number. When the client registers or unregisters the binding it uses only the low 16 bits of the id.
* The stock action bars and morale bar use it to connect their buttons to the hotkeys (see the examples).
* The ''No window specified'' error exists in the client but cannot be raised: a missing name is replaced by an empty string first, which gives the ''does not exist'' error.

== Errors ==
* <code>Error in function call 'WindowSetGameActionTrigger': Window %s does not exist.</code>
* <code>Error in function call 'WindowSetGameActionTrigger': Window %s is currently locked and may not be modified from lua. ...</code><br/>This check never triggers in the current client. See [[API:WindowSetShowing|WindowSetShowing]].

== Example ==
From <code>ea_actionbars/source/actionbutton.lua</code>:
<pre>
WindowSetGameActionTrigger (windowName, GetActionIdFromName (actionButton:GetActionName ()))
</pre>

From <code>ea_moralewindow/source/moralewindow.lua</code>:
<pre>
-- Bind the action buttons to the hotkey keyboard events.
local actionTrigger = SystemData.Settings.Keybindings.MORALE_BAR_1.id + moraleLevel - 1
WindowSetGameActionTrigger (moraleButton:GetName (), actionTrigger)
</pre>

== See also ==
* [[API:WindowSetGameActionData|WindowSetGameActionData]]
* [[API:GetActionIdFromName|GetActionIdFromName]]

API:WindowSetGameActionTrigger - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)