|
|
(3 intermediate revisions by one other user not shown) |
Line 1: |
Line 1: |
− | <div class="toccolours mw-collapsible mw-collapsed tbl-ds">
| + | #REDIRECT [[Global Command: stopAction]] |
− | <span class="bold">Command History</span>
| |
− | <div class="mw-collapsible-content">
| |
− | <div class="alt-bg">Available since v3.7</div>
| |
− | </div></div>
| |
− | | |
− | | |
− | Allows you to stop any "called by other action" you include!
| |
− | | |
− | | |
− | Syntax:
| |
− | <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: 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]]
| |
− | |}
| |