View source for API:CommandPet

{{LuaApi|group=Pet}}
Sends a command (stance, attack, follow, release and so on) to the player's pet.

<pre>
sent = CommandPet(command)
</pre>

== Arguments ==
;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>.

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

== Details ==
* Nothing is sent, and <code>false</code> is returned, if the player has no pet or the player object does not exist yet.
* While one of the player's state flags is set, only command <code>7</code> is sent; all other commands return <code>false</code>.
* <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.
* The client does not check that <code>command</code> is a known value. It is cut to a value from 0 to 255.
* Exactly one argument must be passed. With a wrong argument the function raises the ''Invalid Parameters'' message and still returns <code>false</code>.

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

== Example ==
From <code>default/ea_careerresourceswindow/source/petwindow.lua</code>:
<pre>
function PetStanceButton:OnLButtonUp (flags, x, y)
    local commandSent = CommandPet(self.m_StanceId)

    -- Pretend that a stance command will always work if it is sent
    -- short circuit the update
    local parentPetWindow = self:GetParent ()

    if(parentPetWindow and commandSent) then
        parentPetWindow:UpdatePetState (self.m_StanceId)
</pre>

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