Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:45:46Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Ability}}
Returns whether a toggled ability is currently switched on.

<pre>
isOn = IsAbilityToggledOn(abilityId)
</pre>

== Arguments ==
;abilityId : <code>number</code> – Id of the ability. It is converted to a 16-bit integer.

== Returns ==
;isOn : <code>boolean</code> – <code>true</code> if the ability is in the client's list of toggle states with a non-zero state.

== Details ==
* <code>false</code> is returned for any ability that is not in the list.
* If there is no player object, or the Lua state is not available, the function returns nothing.
* The stock UI never calls this function.

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

== Example ==
A minimal example built from the signature:
<pre>
if( IsAbilityToggledOn( abilityId ) ) then
-- the ability is switched on
end
</pre>

== See also ==
* [[API:IsAbilityEnabled|IsAbilityEnabled]]
* [[API:GetAbilityData|GetAbilityData]]

API:IsAbilityToggledOn - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)