MOAITimer Class Reference

Inheritance diagram for MOAITimer:

Function List
	getSpeed
	getTime
	getTimesExecuted
	setCurve
	setMode
	setSpan
	setSpeed
	setTime
	toggleDirection

Additional Inherited Members
Function List inherited from MOAINode
	clearAttrLink
	clearNodeLink
	forceUpdate
	getAttr
	getAttrLink
	getNodeState
	moveAttr
	scheduleUpdate
	seekAttr
	setAttrLink
	setAttr
	setNodeLink
Function List inherited from MOAIInstanceEventSource
	getListener
	setListener
Function List inherited from MOAIAction
	addChild
	attach
	clear
	defer
	detach
	getChildren
	hasChildren
	isActive
	isBusy
	isDone
	isPaused
	pause
	setAutoStop
	start
	stop
	throttle
	update

Detailed Description

Constants Description MOAITimer.NORMAL MOAITimer.REVERSE MOAITimer.CONTINUE MOAITimer.CONTINUE_REVERSE MOAITimer.LOOP MOAITimer.LOOP_REVERSE MOAITimer.PING_PONG MOAITimer.EVENT_TIMER_KEYFRAME ID of event stop callback. Signature is: nil onKeyframe ( MOAITimer self, number keyframe, number timesExecuted, number time, number value ) MOAITimer.EVENT_TIMER_LOOP ID of event loop callback. Signature is: nil onLoop ( MOAITimer self, number timesExecuted ) MOAITimer.EVENT_TIMER_BEGIN_SPAN Called when timer starts or after roll over (if looping). Signature is: nil onBeginSpan ( MOAITimer self, number timesExecuted ) MOAITimer.EVENT_TIMER_END_SPAN Called when timer ends or before roll over (if looping). Signature is: nil onEndSpan ( MOAITimer self, number timesExecuted )

Attributes MOAITimer.ATTR_TIME

Function Documentation

getSpeed

Return the playback speed.

---

function getSpeed ( MOAITimer self )

Parameters

MOAITimer

self

Returns

number speed

getTime

Return the current time.

---

function getTime ( MOAITimer self )

Parameters

MOAITimer

self

Returns

number time

getTimesExecuted

Gets the number of times the timer has completed a cycle.

---

function getTimesExecuted ( MOAITimer self )

Parameters

MOAITimer

self

Returns

number nTimes

setCurve

Set or clear the curve to use for event generation.

---

function setCurve ( MOAITimer self [, MOAIAnimCurve curve ] )

Parameters

MOAITimer	self
MOAIAnimCurve	curve Optional. Default value is nil.

Returns

nil

setMode

Sets the playback mode of the timer.

---

function setMode ( MOAITimer self, number mode )

Parameters

MOAITimer	self
number	mode One of: MOAITimer.NORMAL, MOAITimer.REVERSE, MOAITimer.LOOP, MOAITimer.LOOP_REVERSE, MOAITimer.PING_PONG

Returns

nil

setSpan

Sets the playback mode of the timer.

---

function setSpan ( MOAITimer self, number endTime )

Parameters

MOAITimer	self
number	endTime

Returns

nil

Note

Span will be 0 to endTime.

---

function setSpan ( MOAITimer self, number startTime, number endTime )

Parameters

MOAITimer	self
number	startTime
number	endTime

Returns

nil

Note

Span will be startTime to endTime.

setSpeed

Sets the playback speed. This affects only the timer, not its children in the action tree.

---

function setSpeed ( MOAITimer self, number speed )

Parameters

MOAITimer	self
number	speed

Returns

nil

setTime

Manually set the current time. This will be wrapped into the current span.

---

function setTime ( MOAITimer self [, number time ] )

Parameters

MOAITimer	self
number	time Optional. Default value is 0.

Returns

nil

toggleDirection

Reverses the current direction of the timer.

---

function toggleDirection ( MOAITimer self )

Parameters

MOAITimer

self

Returns

nil