https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AGetDesiredInteractActionAPI:GetDesiredInteractAction - Revision history2026-10-18T04:54:01ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:GetDesiredInteractAction&diff=30376&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:43:34Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Interact}}<br />
Returns the current "desired interact action": the special cursor mode such as repair, salvage or teleport.<br />
<br />
<pre><br />
action = GetDesiredInteractAction()<br />
</pre><br />
<br />
== Arguments ==<br />
None.<br />
<br />
== Returns ==<br />
;action : <code>number</code> – The current action. The stock UI compares it with <code>SystemData.InteractActions</code> values (<code>NONE</code>, <code>REPAIR</code>, <code>REPAIR_DISABLED</code>, <code>SALVAGE</code>, <code>TELEPORT</code>, <code>DYE</code>, <code>UNLOCK</code> and others).<br />
<br />
== Details ==<br />
* The value is the one last set with [[API:SetDesiredInteractAction|SetDesiredInteractAction]], or by the client itself.<br />
* The client uses the same value to choose the mouse cursor and when the player targets something.<br />
<br />
== Errors ==<br />
None.<br />
<br />
== Example ==<br />
From <code>default/ea_craftingwindow/source/salvagingwindow.lua</code>:<br />
<pre><br />
if( GetDesiredInteractAction() == SystemData.InteractActions.SALVAGE )<br />
then<br />
SetDesiredInteractAction( SystemData.InteractActions.NONE )<br />
end<br />
</pre><br />
<br />
From <code>default/ea_battlegrouphud/source/battlegrouphud.lua</code>:<br />
<pre><br />
if( GetDesiredInteractAction() == SystemData.InteractActions.TELEPORT )<br />
</pre><br />
<br />
== See also ==<br />
* [[API:SetDesiredInteractAction|SetDesiredInteractAction]]</div>Maintenance script