Difference between revisions of "StartAnimation"
From The Official Visionaire Studio: Adventure Game Engine Wiki
Line 16: | Line 16: | ||
Example 1: basic start animation method (default direction) | Example 1: basic start animation method (default direction) | ||
− | <syntaxhighlight | + | <syntaxhighlight enclose="div" line > |
--[[ | --[[ | ||
!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! | !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! |
Revision as of 02:26, 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: link
The link to the animation to be started! ("path"."object"."animation")
Flags: none
Return: visionaireObject
The visionaire object representing the active animation!