![]() |
Murl Engine Lua Addon API
Version 1.0 beta
|
The ITimeline interface.
The timeline is evaluated each logic tick using the IStepable interface.
A simple timeline is specified by a start/end time.
The timeline can be controlled by Start(), Pause() and Stop() calls.
All setters are taking effect immediately even if the timeline is running.
A more detailed timeline can use a loop start/end time, resulting in 3 phases:
The number of loops specifies the counter for of the loop phase.
Endless looping can be achieved by setting number of loops to < 0.
If number of loops is 0 the loop start/end time is ignored which means the timeline simply runs from start to end time.
If the start time is equal to the loop start time the intro phase is skipped.
If the end time is equal to the loop end time the outro phase is skipped.
Get the stepable interface. The ITimeline conforms to the IStepable interface.
Murl.SharedPointer.LogicIStepable GetStepable()
Set the timeline callback object. The IAppTimeline::OnEvaluate() callback method is processed if the timeline's current time is set by IStepable::ProcessTick() or Rewind().
Boolean SetAppTimeline(Murl.SharedPointer.LogicIAppTimeline appTimeline)
appTimeline | The timeline callback object. |
Evaluate the current time immediately. Process the IAppTimeline::OnEvaluate() callback method immediately. This method is rarely used after modifying the timeline's current time. This method is typically called when the timeline's current time was evaluated by IStepable::ProcessTick() within each logic tick. This method is called immediately by Reset(), ResetTo(), Rewind(), Start() with parameters and Stop() if auto rewind is enabled.
Evaluate()
Reset the timeline. Stop the timeline, reset the WasRunning() state and call Rewind(). Finally Evaluate() is called.
Reset()
Reset the timeline to a specified start time. Set the start time and call Reset(). Finally Evaluate() is called.
ResetTo(Number startTime)
startTime | The start time in seconds. |
Start or continue the timeline. Reset the WasRunning() state. Does not modify the current time and loop.
Boolean Start()
Start the timeline with specified parameters. Set start/end time, calls Rewind() and Start(). Finally Evaluate() is called.
Boolean Start(Number startTime, Number endTime)
startTime | The start time in seconds. |
endTime | The end time in seconds. |
Start the timeline with specified parameters. Set start/end time, number of loops, calls Rewind() and Start(). Finally Evaluate() is called.
Boolean Start(Number startTime, Number endTime, Integer numberOfLoops)
startTime | The start time in seconds. |
endTime | The end time in seconds. |
numberOfLoops | Number of loops. |
Start the timeline with specified parameters. Set start/end time, loop start/end time, number of loops, calls Rewind() and Start(). Finally Evaluate() is called.
Boolean Start(Number startTime, Number endTime, Number loopStartTime, Number loopEndTime, Integer numberOfLoops)
startTime | The start time in seconds. |
endTime | The end time in seconds. |
loopStartTime | The loop start time in seconds. |
loopEndTime | The loop end time in seconds. |
numberOfLoops | Number of loops. |
Pause the timeline.
Boolean Pause()
Stop the timeline. Rewind() is called if auto rewind is enabled. Finally Evaluate() is called if auto rewind is enabled.
Boolean Stop()
Rewind the timeline. Sets the current time to the start time and the current loop to the start loop. Does not affect the current running state. Finally Evaluate() is called.
Boolean Rewind()
Set the start time.
SetStartTime(Number startTime)
startTime | The start time in seconds. |
Get the start time.
Number GetStartTime()
Set the end time.
SetEndTime(Number endTime)
endTime | The end time in seconds. |
Get the end time.
Number GetEndTime()
Set the loop start time.
SetLoopStartTime(Number startTime)
startTime | The loop start time in seconds. |
Get the loop start time.
Number GetLoopStartTime()
Set the loop end time.
SetLoopEndTime(Number endTime)
endTime | The loop end time in seconds. |
Get the loop end time.
Number GetLoopEndTime()
Set the number of loops.
SetNumberOfLoops(Integer numberOfLoops)
numberOfLoops | Number of loops. |
Get the number of loops.
Integer GetNumberOfLoops()
Set the time scale factor. The recent tick duration is multiplied by the time scale factor and added to the current time each logic tick. The default time scale factor is 1.
SetTimeScale(Number timeScale)
timeScale | The time scale factor. |
Get the time scale factor.
Number GetTimeScale()
Enable/disable automatic rewind. Automatic rewind is calling Rewind() when the timeline is stopped.
SetAutoRewindEnabled(Boolean enabled)
enabled | Enable automatic rewind if true. |
Check if automatic rewind is enabled.
Boolean IsAutoRewindEnabled()
Check if the timeline is running. A timeline can be started by calling Start() and stopped by calling Stop().
Boolean IsRunning()
Check if the timeline is paused. A timeline can be paused by calling Pause() and continued by calling Start().
Boolean IsPaused()
Check if the timeline is stopped. A timeline can be stopped by calling Stop() and started by calling Start().
Boolean IsStopped()
Check if the timeline was started from stopped state.
Boolean WasStarted()
Check if the timeline has stopped running. If the timeline is stopped this state is true within the current logic tick only and will be cleared at the next logic tick.
(!) This state remains unchanged if the processor holding the timeline's observer is set to inactive within the current logic tick. In such a case the Reset() method can be called to clear the state.
Boolean WasRunning()
Check if the timeline is or was running. Returns (IsRunning() || WasRunning()) state.
Boolean IsOrWasRunning()
Check if the current time has passed a specified time within the most recent tick. Does not consider loops, for evaluating loops see HasPassedLoop().
Boolean HasPassedTime(Number time)
time | The time to check in seconds. |
Check if the current loop has passed a specified loop number within the most recent tick. If the loop number to check is negative, true is returned each time the current loop has changed.
Boolean HasPassedLoop(Integer loop)
loop | The loop number to check. |
Get the current time. This method does not consider loops, for evaluating loops see GetCurrentLoop().
Number GetCurrentTime()
Get the remaining time. This method calculates GetEndTime() - GetCurrentTime() which does not consider loops, for evaluating loops see GetCurrentLoop().
Number GetRemainingTime()
Set the current time. This method does not consider loops, for setting loops see SetCurrentLoop().
SetCurrentTime(Number time)
time | The current time to set in seconds. |
Get the current loop. The current loop provides the following information for n loops:
Integer GetCurrentLoop()
Get the remaining loops. Calculates GetNumberOfLoops() - GetCurrentLoop().
Integer GetRemainingLoops()
Set the current loop. The current loop represents the following information for n loops:
Boolean SetCurrentLoop(Integer loop)
loop | The current loop to set. |
Get the current animation state.
Murl.IEnums.AnimationState GetCurrentState()