Difference between revisions of "StopAction"

From The Official Visionaire Studio: Adventure Game Engine Wiki
Line 55: Line 55:
 
{| style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
 
{| style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
 
|-
 
|-
|<b>Relevant Pages</b>: [[StartpAction|startAction]]
+
|<b>Relevant Pages</b>: [[StartAction|startAction]]
 
|}
 
|}

Revision as of 19:10, 8 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


Relevant Pages: startAction