Difference between revisions of "StartAction"

From The Official Visionaire Studio: Adventure Game Engine Wiki
(Redirected page to Global Command: startAction)
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
+
#REDIRECT [[Global Command: startAction]]
−
<b>Command History</b>
 
−
<div class="mw-collapsible-content">
 
−
<div style="background:#ebebeb" width="100%">Available since <span style="color:orange">v3.7</span></div>
 
−
</div></div>
 
−
 
 
−
 
 
−
Allows you to start any "called by other action" you include!
 
−
 
 
−
 
 
−
Syntax:
 
−
<syntaxhighlight>
 
−
startAction(action)
 
−
</syntaxhighlight>
 
−
 
 
−
 
 
−
Example 1: basic start action method
 
−
<syntaxhighlight enclose="div">
 
−
--[[
 
−
!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!
 
−
startAction("Actions[action_name]")
 
−
 
 
−
 
 
−
-- full get action method; !recommended
 
−
startAction("Scenes[scene_name].SceneObjects[object_name].SceneActions[action_name]")
 
−
</syntaxhighlight>
 
−
 
 
−
Example 2: start action via a variable
 
−
<syntaxhighlight>
 
−
-- you can of course use variables with actions stored in them instead!
 
−
local act = getObject("Actions[action_name]")
 
−
startAction(act)
 
−
</syntaxhighlight>
 
−
 
 
−
 
 
−
 
 
−
<b><u>Arguments</u></b>
 
−
 
 
−
action: path <br/>
 
−
The path to the action to be started! ("path"."object_id"."action")
 
−
 
 
−
Flags: none
 
−
 
 
−
Return: visionaireObject <br/>
 
−
The visionaire object representing the active action!
 
−
{{i18n|StartAction}}
 

Latest revision as of 13:34, 19 May 2023