Difference between revisions of "StopAnimation"

Revision as of 15:32, 12 March 2013

Command History

Available since v3.7

Allows you to stop any active animation; if the animation is not active then nothing happens!

Syntax:

stopAnimation(animation)

Example 1: basic stop animation method

--[[
!important: you must take care when using this method that you don't have multiple instances of animations with the same name otherwise it will not work correctly!
--]]

-- shortened get animation method; !important: see comment above!
stopAnimation("Animations[animation_name]")


-- full get animation method; !recommended
stopAnimation("Scenes[scene_name].SceneObjects[object_name].ObjectAnimations[animation_name]")

Example 2: stop animation via a variable

-- you can of course use variables with animations stored in them instead!
local anim = getObject("Animations[animation_name]")
stopAnimation(anim)

Arguments

animation: path
The path to the animation to be stopped! ("path"."object"."animation")

Flags

none

Return

none

日本語 – 正體中文 – 한국어 – Dansk – Deutsch – English – Español – Français – Italiano – Nederlands – Polski – Português – Svenska – Русский

Relevant Pages: startAnimation

@@ Line 40: / Line 40: @@
 <b><u>Arguments</u></b>
-animation: path <br/>
+<b>animation</b>: path <br/>
 The path to the animation to be stopped! ("path"."object"."animation")
-Flags: none
-Return: none
+<b><u>Flags</u></b>
-{{i18n|StopAnimation}}
+none
+<b><u>Return</u></b>
+none
+{{i18n|StopAnimation}} <br/>
+{| style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
+|-
+|<b>Relevant Pages</b>: [[StartAnimation|startAnimation]]
+|}