Difference between revisions of "StartAnimation"

From The Official Visionaire Studio: Adventure Game Engine Wiki
Line 26: Line 26:
 
startAnimation(anim)
 
startAnimation(anim)
 
</syntaxhighlight>
 
</syntaxhighlight>
[[Category:Player Commands]]
 

Revision as of 21:28, 30 September 2014

startAnimation

Available since: v3.0
Starts an animation. If the animation is already running the existing animation is returned.

Lua Syntax:

startAnimation(animation [, reverse])

Arguments

animation

"object path"|"object id"|object - Visionaire object which specifies an animation.

reverse

true|false - If true the animation is played in reverse order. Default value is false.

Flags

Return Values

visionaireObject
The visionaire object representing the active animation.

Examples

Example 1:

startAnimation("Scenes[scene_name].SceneObjects[object_name].ObjectAnimations[animation_name]"))

Example 2:

local anim = getObject("Animations[animation_name]")
startAnimation(anim)