Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:41:46Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Pet}}
Sends a "toggle ability" command for one of the pet's abilities to the server.

<pre>
sent = CommandPetToggleAbility(abilityId)
</pre>

== Arguments ==
;abilityId : <code>number</code> – ID of the pet ability.

== Returns ==
;sent : <code>boolean</code> – <code>true</code> if the request was sent to the server, <code>false</code> otherwise.

== Details ==
* Sends a "toggle ability" pet command together with <code>abilityId</code>.
* Nothing is sent, and <code>false</code> is returned, if the player has no pet, the player object does not exist yet, or one of the player's state flags blocks pet commands (see [[API:CommandPet|CommandPet]]).
* The client does not check that the pet has the ability.
* Exactly one argument must be passed. If the argument is missing or not a number, two errors are raised: the generic ''Invalid Parameters'' message and the message below.

== Errors ==
* <code>LuaCommandPetToggleAbility: Paramater 1 should be ability id to toggle.</code>

== Example ==
Right-clicking a pet ability button, from <code>default/ea_careerresourceswindow/source/petbutton.lua</code>:
<pre>
function PetButton:OnRButtonDown (flags, x, y)
local slot, actionType, actionId = self:GetActionData ()

if ((actionType == GameData.PlayerActions.COMMAND_PET_DO_ABILITY) and (actionId ~= 0))
then
CommandPetToggleAbility (actionId)
end
end
</pre>

== See also ==
* [[API:CommandPet|CommandPet]]
* [[API:CommandPetDoAbility|CommandPetDoAbility]]

API:CommandPetToggleAbility - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)