Difference between revisions of "StopAction"

Revision as of 18:12, 22 November 2013

stopAction

Available since: v3.0

Stops a running action. If the action is not found (because it is not running) nothing happens.

Lua Syntax:

stopAction(action)

Arguments

action

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

Flags

Return Values

None.

Examples

Example 1:

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

Example 2:

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

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+==stopAction==
-<span class="bold">Command History</span>
-<div class="mw-collapsible-content">
-<div class="alt-bg">Available since v3.7</div>
-</div></div>
+<div class="command-min-version-info">Available since: <span class="command-min-version">v3.0</span></div>
-Allows you to stop any "called by other action" you include!
+<div class="command-doc">Stops a running action. If the action is not found (because it is not running) nothing happens.</div>
+Lua Syntax:
-Syntax:
+<pre class="command-syntax">stopAction(action)</pre>
+===Arguments===
+====action====
+:'''"object path"|"object id"|object''' - Visionaire object which specifies an action.
+===Flags===
+===Return Values===
+None.
+===Examples===
+Example 1:
 <syntaxhighlight>
-stopAction(action)
-</syntaxhighlight>
-Example 1: basic stop action method
-<syntaxhighlight enclose="div">
---[[
-!important: you must take care when using this method that there is only one instance of the action you are calling.
---]]
--- shortened get action method; !important: see comment above!
-stoptAction("Actions[action_name]")
--- full get action method; !recommended
 stoptAction("Scenes[scene_name].SceneObjects[object_name].SceneActions[action_name]")
 </syntaxhighlight>
+Example 2:
-Example 2: stop action via a variable
 <syntaxhighlight>
--- you can of course use variables with actions stored in them instead!
 local act = getObject("Actions[action_name]")
 stoptAction(act)
 </syntaxhighlight>
-<span class="bold underline">Arguments</span>
-<span class="bold">action</span>: path <br/>
-The path to the action to be stopped! ("path"."object_id"."action")
-<span class="bold underline">Flags</span>
-none
-<span class="bold underline">Return</span>
-none
-{{i18n|StopAction}} <br/>
-{| class="tbl-ds"
-|-
-|<span class="bold">Relevant Pages</span>: [[StartAction|startAction]]
-|}