Difference between revisions of "StartAction"

From The Official Visionaire Studio: Adventure Game Engine Wiki
Line 22: Line 22:
  
 
-- shortened get action method; !important: see comment above!
 
-- shortened get action method; !important: see comment above!
startAction([getObject("Actions[action_name]")])
+
startAction("Actions[action_name]")
  
  
 
-- full get action method; !recommended
 
-- full get action method; !recommended
startAction([getObject("Scenes[scene_name].SceneObjects[object_name].SceneActions[action_name]")])
+
startAction("Scenes[scene_name].SceneObjects[object_name].SceneActions[action_name]")
 
</syntaxhighlight>
 
</syntaxhighlight>
  

Revision as of 23:52, 6 March 2013

Command History

Available since v3.7


Allows you to start any "called by other action" you include!


Syntax:

startAction(action)


Example 1: basic start 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!
startAction("Actions[action_name]")


-- full get action method; !recommended
startAction("Scenes[scene_name].SceneObjects[object_name].SceneActions[action_name]")

Example 2: start action via a variable

-- you can of course use variables with actions stored in them instead!
local act = getObject("Actions[action_name]")
startAction(act)


Arguments

action: link
The link to the action to be started! ("path"|"object_id"|"action_name")

Flags: none

Return: visionaireObject
The visionaire object representing the active action!