Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:48:56Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Interact}}
Sets the "desired interact action": the special cursor mode such as repair or salvage.

<pre>
SetDesiredInteractAction(action)
</pre>

== Arguments ==
;action : <code>number</code> – The new action, a <code>SystemData.InteractActions</code> value. Must be 0–13.

== Returns ==
Nothing useful. See Details.

== Details ==
* Values outside 0–13 are ignored and the current action is kept. No error is raised.
* The client uses the value to choose the mouse cursor and when the player targets something. Read it back with [[API:GetDesiredInteractAction|GetDesiredInteractAction]].
* When the value is accepted, the function reports one return value without pushing one, so the call returns the <code>action</code> argument back to the caller. When the value is rejected, it returns nothing. Do not rely on this.
* Exactly one argument must be passed.

== Errors ==
None besides the generic ''Invalid Parameters'' message when the argument is missing or not a number.

== Example ==
From <code>default/ea_craftingwindow/source/salvagingwindow.lua</code>:
<pre>
SetDesiredInteractAction( SystemData.InteractActions.SALVAGE )
</pre>

From <code>default/ea_cursor/source/cursor.lua</code>:
<pre>
if GetDesiredInteractAction() ~= SystemData.InteractActions.NONE then
SetDesiredInteractAction( SystemData.InteractActions.NONE )
</pre>

== See also ==
* [[API:GetDesiredInteractAction|GetDesiredInteractAction]]

API:SetDesiredInteractAction - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)