Difference between revisions of "StartAnimation"

From The Official Visionaire Studio: Adventure Game Engine Wiki
Line 29: Line 29:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Example 2: basic start animation method (reverse/inverse direction)
+
Example 2: basic start animation method (reverse direction)
 
<syntaxhighlight>
 
<syntaxhighlight>
 
-- shortened get animation example; !important: see comment in "example 1"!
 
-- shortened get animation example; !important: see comment in "example 1"!
Line 40: Line 40:
 
local anim = getObject("Animations[animation_name]")
 
local anim = getObject("Animations[animation_name]")
 
startAnimation(anim) -- default direction!
 
startAnimation(anim) -- default direction!
startAnimation(anim, true) -- reversed/inverted direction!
+
startAnimation(anim, true) -- reversed direction!
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 53: Line 53:
 
<b><u>Flags</u></b>
 
<b><u>Flags</u></b>
  
none
+
<b>reverse</b>: bool <br/>
 +
True will play the animation in reverse, whereas false will play the animation forwards! (false is default)
  
  

Revision as of 14:38, 12 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 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 direction!


Arguments

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


Flags

reverse: bool
True will play the animation in reverse, whereas false will play the animation forwards! (false is default)


Return

visionaireObject
The visionaire object representing the active animation!


Relevant Pages: stopAnimation