Difference between revisions of "StartAction"

Revision as of 22:28, 30 September 2014

startAction

Available since: v3.0

Starts an action. If the action is already running a new active action for the action data object is started.

Lua Syntax:

startAction(action)

Arguments

action

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

Flags

Return Values

visionaireObject: The visionaire object representing the active action.

Examples

Example 1:

startAction("Scenes[scene_name].SceneObjects[object_name].SceneActions[action_name]")

Example 2:

local act = getObject("Actions[action_name]")
startAction(act)

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
+==startAction==
-<b>Command History</b>
-<div class="mw-collapsible-content">
-Available since <span style="color:green">v3.7</span>
-</div></div>
+<div class="command-min-version-info">Available since: <span class="command-min-version">v3.0</span></div>
-Allows you to start any "called by other action" you include!
+<div class="command-doc">Starts an action. If the action is already running a new active action for the action data object is started.</div>
-Syntax:
+Lua Syntax:
+<pre class="command-syntax">startAction(action)</pre>
+===Arguments===
+====action====
+:'''"object path"|"object id"|object''' - Visionaire object which specifies an action.
+===Flags===
+===Return Values===
+;visionaireObject
+:The visionaire object representing the active action.
+===Examples===
+Example 1:
 <syntaxhighlight>
-startAction(action)
+startAction("Scenes[scene_name].SceneObjects[object_name].SceneActions[action_name]")
 </syntaxhighlight>
+Example 2:
-Example:
 <syntaxhighlight>
--- shortened get action method; !important: you must not have more than one action with the same name!
-startAction([getObject("Actions[action_name]")])
--- you can of course use variables with actions stored in them instead!
 local act = getObject("Actions[action_name]")
 startAction(act)
--- you can also link to actions inside of scenes, objects, buttons, interfaces etc.
-local act = getObject("Scenes[scene_name].SceneObjects[object_name].SceneActions[action_name]")
-startAction(act)
---[[
-note: it is recommended to use full paths to objects, actions, animations etc as you don't have to worry about
-them not working due to multiple instances using the same name!
---]]
 </syntaxhighlight>
-<b><u>Arguments</u></b>
-action: link <br/>
-The link to the action to be started! ("path|"object_id"|"action_name")
-Flags: none
-Return: visionaireObject <br/>
-The visionaire object representing the active action!
-{{i18n|StartAction}}