MOAIAction Class Reference

Inheritance diagram for MOAIAction:

List of all members.

Function List
	addChild
	attach
	clear
	detach
	isActive
	isBusy
	isDone
	pause
	start
	stop
	throttle

---

Function Documentation

addChild

Attaches a child action for updating.

---

function addChild ( MOAIAction self, MOAIAction child )

Parameters:

self	( MOAIAction )
child	( MOAIAction )

Returns:

self ( MOAIAction )

attach

Attaches a child to a parent action. The child will receive updates from the parent only if the parent is in the action tree.

---

function attach ( MOAIAction self [, MOAIAction parent ] )

Parameters:

self	( MOAIAction )
parent	( MOAIAction ) Optional. Default value is nil; same effect as calling detach ().

Returns:

self ( MOAIAction )

clear

Removes all child actions.

---

function clear ( MOAIAction self )

Parameters:

self	( MOAIAction )

Returns:

self ( MOAIAction )

detach

Detaches an action from its parent (if any) thereby removing it from the action tree. Same effect as calling stop ().

---

function detach ( MOAIAction self )

Parameters:

self	( MOAIAction )

Returns:

self ( MOAIAction )

isActive

Checks to see if an action is currently in the action tree.

---

function isActive ( MOAIAction self )

Parameters:

self	( MOAIAction )

Returns:

isActive ( boolean )

isBusy

Checks to see if an action is currently busy. An action is 'busy' only if it is 'active' and not 'done.'.

---

function isBusy ( MOAIAction self )

Parameters:

self	( MOAIAction )

Returns:

isBusy ( boolean )

isDone

Checks to see if an action is 'done.' Definition of 'done' is up to individual action implementations.

---

function isDone ( MOAIAction self )

Parameters:

self	( MOAIAction )

Returns:

isDone ( boolean )

pause

Leaves the action in the action tree but prevents it from receiving updates. Call pause ( false ) or start () to unpause.

---

function pause ( MOAIAction self [, boolean pause ] )

Parameters:

self	( MOAIAction )
pause	( boolean ) Optional. Default value is 'true.'

Returns:

nil

start

Adds the action to a parent action or the root of the action tree.

---

function start ( MOAIAction self [, MOAIAction parent ] )

Parameters:

self	( MOAIAction )
parent	( MOAIAction ) Optional. Default value is MOAIActionMgr.getRoot ()

Returns:

self ( MOAIAction )

stop

Removed the action from its parent action; action will stop being updated.

---

function stop ( MOAIAction self )

Parameters:

self	( MOAIAction )

Returns:

self ( MOAIAction )

throttle

Sets the actions throttle. Throttle is a scalar on time. Is is passed to the action's children.

---

function throttle ( MOAIAction self [, number throttle ] )

Parameters:

self	( MOAIAction )
throttle	( number ) Optional. Default value is 1.

Returns:

self ( MOAIAction )