MOAINode Class Reference

Inheritance diagram for MOAINode:

Function List
	clearAttrLink
	clearNodeLink
	forceUpdate
	getAttr
	getAttrLink
	getNodeState
	moveAttr
	scheduleUpdate
	seekAttr
	setAttrLink
	setAttr
	setNodeLink
Function List inherited from MOAIInstanceEventSource
	getListener
	setListener

Function Documentation

clearAttrLink

Clears an attribute pull link - call this from the node receiving the attribute value.

---

function clearAttrLink ( MOAINode self, number attrID )

Parameters

MOAINode	self
number	attrID

Returns

nil

clearNodeLink

Clears a dependency on a foreign node.

---

function clearNodeLink ( MOAINode self, MOAINode sourceNode )

Parameters

MOAINode	self
MOAINode	sourceNode

Returns

nil

forceUpdate

Evaluates the dependency graph for this node. Typically, the entire active dependency graph is evaluated once per frame, but in some cases it may be desirable to force evaluation of a node to make sure source dependencies are propagated to it immediately.

---

function forceUpdate ( MOAINode self )

Parameters

MOAINode

self

Returns

nil

getAttr

Returns the value of the attribute if it exists or nil if it doesn't.

---

function getAttr ( MOAINode self, number attrID )

Parameters

MOAINode	self
number	attrID

Returns

number value

getAttrLink

Returns the link if it exists or nil if it doesn't.

---

function getAttrLink ( MOAINode self, number attrID )

Parameters

MOAINode	self
number	attrID

Returns

MOAINode sourceNode, number sourceAttrID

getNodeState

Returns the current state of the node (for debugging purposes).

---

function getNodeState ( MOAINode self )

Parameters

MOAINode

self

Returns

number state

moveAttr

Animate the attribute by applying a delta. Creates and returns a MOAIEaseDriver initialized to apply the delta.

---

function moveAttr ( MOAINode self, number attrID, number delta, number length [, number mode ] )

Parameters

MOAINode	self
number	attrID ID of the attribute to animate.
number	delta Total change to be added to attribute.
number	length Length of animation in seconds.
number	mode Optional. The ease mode. One of MOAIEaseType.EASE_IN, MOAIEaseType.EASE_OUT, MOAIEaseType.FLAT MOAIEaseType.LINEAR, MOAIEaseType.SMOOTH, MOAIEaseType.SOFT_EASE_IN, MOAIEaseType.SOFT_EASE_OUT, MOAIEaseType.SOFT_SMOOTH. Defaults to MOAIEaseType.SMOOTH.

Returns

MOAIEaseDriver easeDriver

scheduleUpdate

Schedule the node for an update next time the dependency graph is processed. Any dependent nodes will also be updated.

---

function scheduleUpdate ( MOAINode self )

Parameters

MOAINode

self

Returns

nil

seekAttr

Animate the attribute by applying a delta. Delta is computed given a target value. Creates and returns a MOAIEaseDriver initialized to apply the delta.

---

function seekAttr ( MOAINode self, number attrID, number goal, number length [, number mode ] )

Parameters

MOAINode	self
number	attrID ID of the attribute to animate.
number	goal Desired resulting value for attribute.
number	length Length of animation in seconds.
number	mode Optional. The ease mode. One of MOAIEaseType.EASE_IN, MOAIEaseType.EASE_OUT, MOAIEaseType.FLAT MOAIEaseType.LINEAR, MOAIEaseType.SMOOTH, MOAIEaseType.SOFT_EASE_IN, MOAIEaseType.SOFT_EASE_OUT, MOAIEaseType.SOFT_SMOOTH. Defaults to MOAIEaseType.SMOOTH.

Returns

MOAIEaseDriver easeDriver

setAttr

Sets the value of an attribute.

---

function setAttr ( MOAINode self, number attrID, number value )

Parameters

MOAINode	self
number	attrID
number	value

Returns

nil

setAttrLink

Sets a pull attribute connecting an attribute in the node to an attribute in a foreign node.

---

function setAttrLink ( MOAINode self, number attrID, MOAINode sourceNode [, number sourceAttrID ] )

Parameters

MOAINode	self
number	attrID ID of attribute to become dependent of foreign node.
MOAINode	sourceNode Foreign node.
number	sourceAttrID Optional. Attribute in foreign node to control value of attribue. Default value is attrID.

Returns

nil

setNodeLink

Creates a dependency between the node and a foreign node without the use of attributes; if the foreign node is updated, the dependent node will be updated after.

---

function setNodeLink ( MOAINode self, MOAINode sourceNode )

Parameters

MOAINode	self
MOAINode	sourceNode

Returns

nil