https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3ACommandPetAPI:CommandPet - Revision history2026-10-17T08:19:12ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:CommandPet&diff=30259&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:41:44Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Pet}}<br />
Sends a command (stance, attack, follow, release and so on) to the player's pet.<br />
<br />
<pre><br />
sent = CommandPet(command)<br />
</pre><br />
<br />
== Arguments ==<br />
;command : <code>number</code> – One of the <code>GameData.PetCommand</code> values, for example <code>GameData.PetCommand.AGGRESSIVE</code>, <code>.DEFENSIVE</code>, <code>.PASSIVE</code>, <code>.ATTACK</code>, <code>.STAY</code>, <code>.FOLLOW</code> or <code>.RELEASE</code>.<br />
<br />
== Returns ==<br />
;sent : <code>boolean</code> – <code>true</code> if the command was sent to the server, <code>false</code> otherwise.<br />
<br />
== Details ==<br />
* Nothing is sent, and <code>false</code> is returned, if the player has no pet or the player object does not exist yet.<br />
* While one of the player's state flags is set, only command <code>7</code> is sent; all other commands return <code>false</code>.<br />
* <code>true</code> only means the request was sent. Whether the pet obeys is decided by the server; the stock pet window assumes a sent stance command works and updates its display at once.<br />
* The client does not check that <code>command</code> is a known value. It is cut to a value from 0 to 255.<br />
* Exactly one argument must be passed. With a wrong argument the function raises the ''Invalid Parameters'' message and still returns <code>false</code>.<br />
<br />
== Errors ==<br />
None besides the generic ''Invalid Parameters'' message when the argument is missing or not a number.<br />
<br />
== Example ==<br />
From <code>default/ea_careerresourceswindow/source/petwindow.lua</code>:<br />
<pre><br />
function PetStanceButton:OnLButtonUp (flags, x, y)<br />
local commandSent = CommandPet(self.m_StanceId)<br />
<br />
-- Pretend that a stance command will always work if it is sent<br />
-- short circuit the update<br />
local parentPetWindow = self:GetParent ()<br />
<br />
if(parentPetWindow and commandSent) then<br />
parentPetWindow:UpdatePetState (self.m_StanceId)<br />
</pre><br />
<br />
== See also ==<br />
* [[API:CommandPetDoAbility|CommandPetDoAbility]]<br />
* [[API:CommandPetToggleAbility|CommandPetToggleAbility]]</div>Maintenance script