Difference between revisions of "StopAction"
From The Official Visionaire Studio: Adventure Game Engine Wiki
(Created page with "<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"> <b>Command History</b> <div class="mw-collapsible-co...") |
|||
Line 11: | Line 11: | ||
Syntax: | Syntax: | ||
<syntaxhighlight> | <syntaxhighlight> | ||
− | + | stopAction(action) | |
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 19:11, 7 March 2013
Command History
Available since v3.7
Allows you to stop any "called by other action" you include!
Syntax:
stopAction(action)
Example 1: basic stop action method
--[[
!important: you must take care when using this method that you don't have multiple instances of actions with the same name otherwise it will not work correctly!
--]]
-- 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]")
Example 2: stop action via a variable
-- you can of course use variables with actions stored in them instead!
local act = getObject("Actions[action_name]")
stoptAction(act)
Arguments
action: path
The path to the action to be stopped! ("path"."object_id"."action")
Flags: none
Return: none