View source for StopAnim

<!-- This page is generated automatically from the function definition: stopAnim. -->
= stopAnim =
Stops a scripted visual animation previously requested for a player.

== Syntax ==
<syntaxhighlight lang="lua">
bool stopAnim(int playerId)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player identifier.
|}

== Returns ==
Returns <code>true</code> when the stop request is accepted and queued; otherwise returns <code>false</code>.

== Examples ==
Stop a scripted animation:
<syntaxhighlight lang="lua" line>
stopAnim(playerId)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* Experimental: this affects the scripted animation layer and does not replace the normal replicated locomotion or action system.

[[Category:Server Functions]]
[[Category:Animation Functions]]
[[Category:Experimental Lua API]]