Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:41:02Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Ability}}
Cancels the ability the player is currently using or placing, and reports whether there was one.

<pre>
cancelled = CancelSpell()
</pre>

== Arguments ==
None.

== Returns ==
;cancelled : <code>boolean</code> – <code>true</code> if something was cancelled, <code>false</code> if there was nothing to cancel.

== Details ==
* If the player has picked an ability that is still waiting for its target to be placed (for example a ground-targeted ability showing its targeting circle), that ability is dropped and <code>true</code> is returned.
* Otherwise the client tries to cancel the ability currently being cast and returns <code>true</code> if that worked.
* Returns <code>false</code> if the player object does not exist yet.
* Arguments are not checked; anything passed is ignored.

== Errors ==
None.

== Example ==
The stock UI wraps it in <code>Player.CancelSpell</code> (<code>default/easystem_utils/source/player.lua</code>):
<pre>
function Player.CancelSpell ()
local wasUsingAnAbility = CancelSpell ()

return wasUsingAnAbility
end
</pre>

The Escape key handler uses that first, from <code>default/easystem_windowutils/source/windowutils.lua</code>:
<pre>
-- (1) Cancel the active ability, returns false if there was nothing to cancel
if( Player.CancelSpell() )
then
return;
end
</pre>

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

API:CancelSpell - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)