Global Command: stopAnimation - Revision history

EK: Created page with "Stop a running animation. {| class="ts" |- | style="width:15%" | Related functions | startAnimation |} == Syntax ==
2023-05-03T11:08:58Z

Created page with "Stop a running animation. {| class="ts" |- | style="width:15%" | Related functions | startAnimation |} == Syntax == <syntaxhighlight lang..."

New page
Stop a running animation.

{| class="ts"
|-
| style="width:15%" | Related functions
| [[Global Command: startAnimation|startAnimation]]
|}

== Syntax ==
<syntaxhighlight lang="lua">
stopAnimation(animation)
</syntaxhighlight>

== Parameters ==

{| class="ts"
|-
! style="width:15%" | Parameter
! style="width:15%" | Type
! Description
|-
| animation
| TVisObj
| Visionaire object representing an animation.
|}

== Return values ==

none

== Examples ==

'''Example 1:''' Stop an animation.
<syntaxhighlight lang="lua">
local myAnimation = Animations["animation_name"]
stopAnimation(myAnimation)
</syntaxhighlight>

'''Example 2:''' Start an animation and stop it after a certain time, depending on a Visionaire value called "duration" holding the amount of seconds.
<syntaxhighlight lang="lua">
local myDelay = Values["duration"].Int
myAnimation = Animations["animation_name"]

startAnimation(myAnimation)
setDelay(myDelay * 1000, "stopAnimation(myAnimation)")
</syntaxhighlight>
{{toc}}