Difference between revisions of "StopAnimation"
From The Official Visionaire Studio: Adventure Game Engine Wiki
| Line 1: | Line 1: | ||
| − | <div class="toccolours mw-collapsible mw-collapsed" | + | <div class="toccolours mw-collapsible mw-collapsed tbl-ds"> |
| − | + | <span class="bold">Command History</span> | |
<div class="mw-collapsible-content"> | <div class="mw-collapsible-content"> | ||
| − | <div | + | <div class="alt-bg">Available since v3.7</div> |
</div></div> | </div></div> | ||
| Line 38: | Line 38: | ||
| − | < | + | <span class="bold underline">Arguments</span> |
| − | < | + | <span class="bold">animation</span>: path <br/> |
The path to the animation to be stopped! ("path"."object"."animation") | The path to the animation to be stopped! ("path"."object"."animation") | ||
| − | < | + | <span class="bold underline">Flags</span> |
none | none | ||
| − | < | + | <span>Return</span> |
none | none | ||
{{i18n|StopAnimation}} <br/> | {{i18n|StopAnimation}} <br/> | ||
| − | {| | + | {| class="tbl-ds" |
|- | |- | ||
| − | |< | + | |<span class="bold">Relevant Pages</span>: [[StartAnimation|startAnimation]] |
|} | |} | ||
Revision as of 12:52, 5 April 2013
Command History
Available since v3.7
Allows you to stop any active animation; if the animation is not active then nothing happens!
Syntax:
stopAnimation(animation)
Example 1: basic stop animation method
--[[
!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!
stopAnimation("Animations[animation_name]")
-- full get animation method; !recommended
stopAnimation("Scenes[scene_name].SceneObjects[object_name].ObjectAnimations[animation_name]")Example 2: stop animation via a variable
-- you can of course use variables with animations stored in them instead!
local anim = getObject("Animations[animation_name]")
stopAnimation(anim)
Arguments
animation: path
The path to the animation to be stopped! ("path"."object"."animation")
Flags
none
Return
none
|
日本語 – 正體中文 – 한국어 – Dansk – Deutsch – English – Español – Français – Italiano – Nederlands – Polski – Português – Svenska – Русский |
| Relevant Pages: startAnimation |
