Murl Engine Lua Addon API  Version 1.0 beta
Murl.Logic.Timeline

The ITimeline interface implementation.


Table members

Inherited


Murl.Logic.ITimeline
Murl.Logic.Stepable

Functions


Murl.Logic.Timeline.new()

Create a timeline object.

Murl.SharedPointer.LogicITimeline new()

Returns
Murl.SharedPointer.LogicITimeline The created timeline object, or null if failed.

Murl.Logic.Timeline.Create()

Create a timeline object.

Murl.SharedPointer.LogicITimeline Create()

Returns
Murl.SharedPointer.LogicITimeline The created timeline object, or null if failed.


Methods


ProcessTick(state)

Implementation of IStepable::ProcessTick() method.

ProcessTick(Murl.Logic.IState state)

Parameters
stateThe IState object.

GetStepable()

Implementation of ITimeline::GetStepable() method.

Murl.SharedPointer.LogicIStepable GetStepable()

Returns
Murl.SharedPointer.LogicIStepable The stepable interface shared pointer.

SetAppTimeline(appTimeline)

Implementation of ITimeline::SetAppTimeline() method.

Boolean SetAppTimeline(Murl.SharedPointer.LogicIAppTimeline appTimeline)

Parameters
appTimelineThe timeline callback object.
Returns
Boolean true if successful.

Evaluate()

Implementation of ITimeline::Evaluate() method.

Evaluate()


Reset()

Implementation of ITimeline::Reset() and IStepable::Reset() method.

Reset()


ResetTo(startTime)

Implementation of ITimeline::ResetTo() method.

ResetTo(Number startTime)

Parameters
startTimeThe start time in seconds.

Start()

Implementation of ITimeline::Start() method.

Boolean Start()

Returns
Boolean true if successful.

Start(startTime, endTime)

Implementation of ITimeline::Start(Real startTime, Real endTime) method.

Boolean Start(Number startTime, Number endTime)

Parameters
startTimeThe start time in seconds.
endTimeThe end time in seconds.
Returns
Boolean true if successful.

Start(startTime, endTime, numberOfLoops)

Implementation of ITimeline::Start(Real startTime, Real endTime, SInt32 numberOfLoops) method.

Boolean Start(Number startTime, Number endTime, Integer numberOfLoops)

Parameters
startTimeThe start time in seconds.
endTimeThe end time in seconds.
numberOfLoopsNumber of loops.
Returns
Boolean true if successful.

Start(startTime, endTime, loopStartTime, loopEndTime, numberOfLoops)

Implementation of ITimeline::Start(Real startTime, Real endTime, Real loopStartTime, Real loopEndTime, SInt32 numberOfLoops) method.

Boolean Start(Number startTime, Number endTime, Number loopStartTime, Number loopEndTime, Integer numberOfLoops)

Parameters
startTimeThe start time in seconds.
endTimeThe end time in seconds.
loopStartTimeThe loop start time in seconds.
loopEndTimeThe loop end time in seconds.
numberOfLoopsNumber of loops.
Returns
Boolean true if successful.

Pause()

Implementation of ITimeline::Pause() method.

Boolean Pause()

Returns
Boolean true if timeline was paused, false if timeline is not running.

Stop()

Implementation of ITimeline::Stop() method.

Boolean Stop()

Returns
Boolean true if timeline was stopped, false if timeline is already stopped.

Rewind()

Implementation of ITimeline::Rewind() method.

Boolean Rewind()

Returns
Boolean true if successful.

SetStartTime(startTime)

Implementation of ITimeline::SetStartTime() method.

SetStartTime(Number startTime)

Parameters
startTimeThe start time in seconds.

GetStartTime()

Implementation of ITimeline::GetStartTime() method.

Number GetStartTime()

Returns
Number The start time in seconds.

SetEndTime(endTime)

Implementation of ITimeline::SetEndTime() method.

SetEndTime(Number endTime)

Parameters
endTimeThe end time in seconds.

GetEndTime()

Implementation of ITimeline::GetEndTime() method.

Number GetEndTime()

Returns
Number The end time in seconds.

SetLoopStartTime(startTime)

Implementation of ITimeline::SetLoopStartTime() method.

SetLoopStartTime(Number startTime)

Parameters
startTimeThe loop start time in seconds.

GetLoopStartTime()

Implementation of ITimeline::GetLoopStartTime() method.

Number GetLoopStartTime()

Returns
Number The loop start time in seconds.

SetLoopEndTime(endTime)

Implementation of ITimeline::SetLoopEndTime() method.

SetLoopEndTime(Number endTime)

Parameters
endTimeThe loop end time in seconds.

GetLoopEndTime()

Implementation of ITimeline::GetLoopEndTime() method.

Number GetLoopEndTime()

Returns
Number The loop end time in seconds.

SetNumberOfLoops(numberOfLoops)

Implementation of ITimeline::SetNumberOfLoops() method.

SetNumberOfLoops(Integer numberOfLoops)

Parameters
numberOfLoopsNumber of loops.

GetNumberOfLoops()

Implementation of ITimeline::GetNumberOfLoops() method.

Integer GetNumberOfLoops()

Returns
Integer The number of loops.

SetTimeScale(timeScale)

Implementation of ITimeline::SetTimeScale() method.

SetTimeScale(Number timeScale)

Parameters
timeScaleThe time scale factor.

GetTimeScale()

Implementation of ITimeline::GetTimeScale() method.

Number GetTimeScale()

Returns
Number true The time scale factor.

SetAutoRewindEnabled(enabled)

Implementation of ITimeline::SetAutoRewindEnabled() method.

SetAutoRewindEnabled(Boolean enabled)

Parameters
enabledEnable automatic rewind if true.

IsAutoRewindEnabled()

Implementation of ITimeline::IsAutoRewindEnabled() method.

Boolean IsAutoRewindEnabled()

Returns
Boolean true if automatic rewind.

IsRunning()

Implementation of ITimeline::IsRunning() method.

Boolean IsRunning()

Returns
Boolean true if running.

IsPaused()

Implementation of ITimeline::IsPaused() method.

Boolean IsPaused()

Returns
Boolean true if paused.

IsStopped()

Implementation of ITimeline::IsStopped() method.

Boolean IsStopped()

Returns
Boolean true if stopped.

WasStarted()

Implementation of ITimeline::WasStarted() method.

Boolean WasStarted()

Returns
Boolean true if started.

WasRunning()

Implementation of ITimeline::WasRunning() method.

Boolean WasRunning()

Returns
Boolean true if stopped.

IsOrWasRunning()

Implementation of ITimeline::IsOrWasRunning() method.

Boolean IsOrWasRunning()

Returns
Boolean true if IsRunning() or WasRunning() is true.

HasPassedTime(time)

Implementation of ITimeline::HasPassedTime() method.

Boolean HasPassedTime(Number time)

Parameters
timeThe time to check in seconds.
Returns
Boolean true if the current time has passed a specified time within the most recent tick.

HasPassedLoop(loop)

Implementation of ITimeline::HasPassedLoop() method.

Boolean HasPassedLoop(Integer loop)

Parameters
loopThe loop number to check.
Returns
Boolean true if the current loop has passed a specified loop within the most recent tick.

GetCurrentTime()

Implementation of ITimeline::GetCurrentTime() method.

Number GetCurrentTime()

Returns
Number The current time in seconds.

GetRemainingTime()

Implementation of ITimeline::GetRemainingTime() method.

Number GetRemainingTime()

Returns
Number The remaining time in seconds.

SetCurrentTime(time)

Implementation of ITimeline::SetCurrentTime() method.

SetCurrentTime(Number time)

Parameters
timeThe current time to set in seconds.

GetCurrentLoop()

Implementation of ITimeline::GetCurrentLoop() method.

Integer GetCurrentLoop()

Returns
Integer The current loop, 0 if number of loops is 0.

GetRemainingLoops()

Implementation of ITimeline::GetRemainingLoops() method.

Integer GetRemainingLoops()

Returns
Integer The remaining loops, -1 if number of loops is < 0, 0 if number of loops is 0 or intro/outro is running.

SetCurrentLoop(loop)

Implementation of ITimeline::SetCurrentLoop() method.

Boolean SetCurrentLoop(Integer loop)

Parameters
loopThe current loop to set.
Returns
Boolean true if successful, false if the loop number is out of range.

GetCurrentState()

Implementation of ITimeline::GetCurrentState() method.

Murl.IEnums.AnimationState GetCurrentState()

Returns
Murl.IEnums.AnimationState The current animation state.