StartAnimation - Revision history

EK: Redirected page to Global Command: startAnimation

2023-05-19T11:34:54Z

Redirected page to Global Command: startAnimation

AFRLme at 16:41, 10 March 2017

2017-03-10T16:41:42Z

Vis apiuser at 20:28, 30 September 2014

2014-09-30T20:28:10Z

Vis apiuser at 13:57, 26 November 2013

2013-11-26T13:57:10Z

Vis apiuser at 16:12, 22 November 2013

2013-11-22T16:12:32Z

AFRLme at 11:56, 4 April 2013

2013-04-04T11:56:46Z

AFRLme at 13:38, 12 March 2013

2013-03-12T13:38:45Z

AFRLme at 13:34, 12 March 2013

2013-03-12T13:34:43Z

AFRLme at 17:57, 7 March 2013

2013-03-07T17:57:58Z

AFRLme at 04:32, 7 March 2013

2013-03-07T04:32:32Z

← Older revision		Revision as of 11:34, 19 May 2023
Line 1:		Line 1:
−	~~==startAnimation==~~	+	#REDIRECT [[Global Command: startAnimation]]
−
−	~~<div class="command-min-version-info">Available since: <span class="command-min-version">v3.0</span></div>~~
−
−	~~<div class="command-doc">Starts an animation. If the animation is already running the existing animation is returned.</div>~~
−
−	~~Lua Syntax:~~
−	~~<pre class="command-syntax">startAnimation(animation~~ [~~, reverse])</pre>~~
−	~~===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:~~
−	~~<syntaxhighlight>~~
−	startAnimation~~("Scenes[scene_name].SceneObjects[object_name].ObjectAnimations[animation_name~~]")
−	~~</syntaxhighlight>~~
−	~~Example 2:~~
−	~~<syntaxhighlight>~~
−	~~local anim = getObject("Animations[animation_name~~]")
−	~~startAnimation(anim)~~
−	~~</syntaxhighlight>~~

@@ Line 19: / Line 19: @@
 Example 1:
 <syntaxhighlight>
-startAnimation("Scenes[scene_name].SceneObjects[object_name].ObjectAnimations[animation_name]"))
+startAnimation("Scenes[scene_name].SceneObjects[object_name].ObjectAnimations[animation_name]")
 </syntaxhighlight>
 Example 2:

← Older revision		Revision as of 20:28, 30 September 2014
Line 26:		Line 26:
	startAnimation(anim)		startAnimation(anim)
	</syntaxhighlight>		</syntaxhighlight>
−	~~[[Category:Player Commands]]~~

← Older revision		Revision as of 13:57, 26 November 2013
Line 26:		Line 26:
	startAnimation(anim)		startAnimation(anim)
	</syntaxhighlight>		</syntaxhighlight>
		+	[[Category:Player Commands]]

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+==startAnimation==
-Allows you to play any animation; if the animation is already playing then the existing animation is returned!
+<div class="command-doc">Starts an animation. If the animation is already running the existing animation is returned.</div>
+Lua Syntax:
-Syntax:
+<pre class="command-syntax">startAnimation(animation [, reverse])</pre>
-<syntaxhighlight>
+===Arguments===
-startAnimation(animation, reverse=true/false)
+====animation====
-</syntaxhighlight>
+:'''"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.
-Example 1: basic start animation method (default direction)
+===Flags===
-<syntaxhighlight>
+===Return Values===
---[[
+;visionaireObject
-!important: you must take care when using this method that there is only instance of the animation you are calling.
+:The visionaire object representing the active animation.
---]]
+===Examples===
+Example 1:
 <syntaxhighlight>
--- shortened get animation example; !important: see comment in "example 1"!
+startAnimation("Scenes[scene_name].SceneObjects[object_name].ObjectAnimations[animation_name]"))
 </syntaxhighlight>
+Example 2:
 <syntaxhighlight>
 local anim = getObject("Animations[animation_name]")
-startAnimation(anim) -- default direction!
+startAnimation(anim)
 </syntaxhighlight>

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
+<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
-<b>Command History</b>
+<span class="bold">Command History</span>
 <div class="mw-collapsible-content">
-<div style="background:#ebebeb" width="100%">Available since <span style="color:orange">v3.7</span></div>
+<div class="alt-bg">Available since v3.7</div>
 </div></div>
@@ Line 18: / Line 18: @@
 <syntaxhighlight>
 --[[
-!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 there is only instance of the animation you are calling.
 --]]
@@ Line 45: / Line 45: @@
-<b><u>Arguments</u></b>
+<span class="bold underline">Arguments</span>
-<b>animation</b>: path <br/>
+<span class="bold">animation</span>: path <br/>
 The path to the animation to be started! ("path"."object"."animation")
-<b><u>Flags</u></b>
+<span class="bold underline">Flags</span>
-<b>reverse</b>: bool <br/>
+<span class="bold">reverse</span>: boolean (true/false) <br/>
 True will play the animation in reverse, whereas false will play the animation forwards! (false is default)
-<b><u>Return</u></b>
+<span class="bold underline">Return</span>
-<b>visionaireObject</b> <br/>
+<span class="bold">visionaireObject</span> <br/>
 The visionaire object representing the active animation!
 {{i18n|StartAnimation}} <br/>
-{| style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
+{| class="tbl-ds"
 |-
-|<b>Relevant Pages</b>: [[StopAnimation|stopAnimation]]
+|<span clasS="bold">Relevant Pages</span>: [[StopAnimation|stopAnimation]]
 |}

@@ Line 2: / Line 2: @@
 <b>Command History</b>
 <div class="mw-collapsible-content">
-Available since <span style="color:green">v3.7</span>
+<div style="background:#ebebeb" width="100%">Available since <span style="color:orange">v3.7</span></div>
 </div></div>
@@ Line 42: / Line 42: @@
 startAnimation(anim, true) -- reversed/inverted direction!
 </syntaxhighlight>
 <b><u>Arguments</u></b>
-animation: link <br/>
+animation: path <br/>
-The link to the animation to be started! ("path"."object"."animation")
+The path to the animation to be started! ("path"."object"."animation")
 Flags: none