StartAction

From The Official Visionaire Studio: Adventure Game Engine Wiki
Revision as of 19:05, 8 March 2013 by AFRLme (talk)

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: path
The path to the action to be started! ("path"."object_id"."action")

Flags: none

Return: visionaireObject
The visionaire object representing the active action!

Relevant Pages: stopAction