|
|
| (4 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| − | <div class="toccolours mw-collapsible mw-collapsed tbl-ds">
| + | #REDIRECT [[Global Command: startAnimation]] |
| − | <span class="bold">Command History</span>
| |
| − | <div class="mw-collapsible-content">
| |
| − | <div class="alt-bg">Available since v3.7</div>
| |
| − | </div></div>
| |
| − | | |
| − | | |
| − | Allows you to play any animation; if the animation is already playing then the existing animation is returned!
| |
| − | | |
| − | | |
| − | Syntax:
| |
| − | <syntaxhighlight>
| |
| − | startAnimation(animation, reverse=true/false)
| |
| − | </syntaxhighlight>
| |
| − | | |
| − | | |
| − | Example 1: basic start animation method (default direction)
| |
| − | <syntaxhighlight>
| |
| − | --[[
| |
| − | !important: you must take care when using this method that there is only instance of the animation you are calling.
| |
| − | --]]
| |
| − | | |
| − | -- shortened get animation method; !important: see comment above!
| |
| − | startAnimation("Animations[animation_name]")
| |
| − | | |
| − | | |
| − | -- full get animation method; !recommended
| |
| − | startAnimation("Scenes[scene_name].SceneObjects[object_name].ObjectAnimations[animation_name]") | |
| − | </syntaxhighlight>
| |
| − | | |
| − | Example 2: basic start animation method (reverse direction)
| |
| − | <syntaxhighlight>
| |
| − | -- shortened get animation example; !important: see comment in "example 1"!
| |
| − | startAnimation("Animations[animation_name", true)
| |
| − | </syntaxhighlight>
| |
| − | | |
| − | Example 3: start animation via a variable
| |
| − | <syntaxhighlight>
| |
| − | -- you can of course use variables with animations stored in them instead!
| |
| − | local anim = getObject("Animations[animation_name]")
| |
| − | startAnimation(anim) -- default direction!
| |
| − | startAnimation(anim, true) -- reversed direction!
| |
| − | </syntaxhighlight>
| |
| − | | |
| − | | |
| − | | |
| − | <span class="bold underline">Arguments</span>
| |
| − | | |
| − | <span class="bold">animation</span>: path <br/>
| |
| − | The path to the animation to be started! ("path"."object"."animation")
| |
| − | | |
| − | | |
| − | <span class="bold underline">Flags</span>
| |
| − | | |
| − | <span class="bold">reverse</span>: boolean (true/false) <br/>
| |
| − | True will play the animation in reverse, whereas false will play the animation forwards! (false is default)
| |
| − | | |
| − | | |
| − | <span class="bold underline">Return</span>
| |
| − | | |
| − | <span class="bold">visionaireObject</span> <br/>
| |
| − | The visionaire object representing the active animation!
| |
| − | {{i18n|StartAnimation}} <br/>
| |
| − | {| class="tbl-ds"
| |
| − | |-
| |
| − | |<span clasS="bold">Relevant Pages</span>: [[StopAnimation|stopAnimation]]
| |
| − | |}
| |
