Difference between revisions of "StopAnimation"

From The Official Visionaire Studio: Adventure Game Engine Wiki
(Redirected page to Global Command: stopAnimation)
 
Line 1: Line 1:
==stopAnimation==
+
#REDIRECT [[Global Command: stopAnimation]]
 
 
<div class="command-min-version-info">Available since: <span class="command-min-version">v3.0</span></div>
 
 
 
<div class="command-doc">Stops a running animation. If the animation is preloaded but not active or not active at all then nothing happens.</div>
 
 
 
Lua Syntax:
 
<pre class="command-syntax">stopAnimation(animation)</pre>
 
===Arguments===
 
====animation====
 
:'''"object path"|"object id"|object''' - Visionaire object which specifies an animation.
 
===Flags===
 
===Return Values===
 
None.
 
===Examples===
 
Example 1:  
 
<syntaxhighlight>
 
stopAnimation("Scenes[scene_name].SceneObjects[object_name].ObjectAnimations[animation_name]")
 
</syntaxhighlight>
 
Example 2:
 
<syntaxhighlight>
 
local anim = getObject("Animations[animation_name]")
 
stopAnimation(anim)
 
</syntaxhighlight>
 

Latest revision as of 13:36, 19 May 2023