Difference between revisions of "StartAnimation"
From The Official Visionaire Studio: Adventure Game Engine Wiki
Line 2: | Line 2: | ||
<b>Command History</b> | <b>Command History</b> | ||
<div class="mw-collapsible-content"> | <div class="mw-collapsible-content"> | ||
− | Available since <span style="color: | + | <div style="background:#ebebeb" width="100%">Available since <span style="color:orange">v3.7</span></div> |
</div></div> | </div></div> | ||
Line 42: | Line 42: | ||
startAnimation(anim, true) -- reversed/inverted direction! | startAnimation(anim, true) -- reversed/inverted direction! | ||
</syntaxhighlight> | </syntaxhighlight> | ||
+ | |||
+ | |||
<b><u>Arguments</u></b> | <b><u>Arguments</u></b> | ||
− | animation: | + | animation: path <br/> |
− | The | + | The path to the animation to be started! ("path"."object"."animation") |
Flags: none | Flags: none |
Revision as of 18:57, 7 March 2013
Command History
Available since v3.7
Allows you to play any animation; if the animation is already playing then the existing animation is returned!
Syntax:
startAnimation(animation, reverse=true/false)
Example 1: basic start animation method (default direction)
--[[
!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!
startAnimation("Animations[animation_name]")
-- full get animation method; !recommended
startAnimation("Scenes[scene_name].SceneObjects[object_name].ObjectAnimations[animation_name]")
Example 2: basic start animation method (reverse/inverse direction)
-- shortened get animation example; !important: see comment in "example 1"!
startAnimation("Animations[animation_name", true)
Example 3: start animation via a variable
-- 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/inverted direction!
Arguments
animation: path
The path to the animation to be started! ("path"."object"."animation")
Flags: none
Return: visionaireObject
The visionaire object representing the active animation!