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

The ITimeframe interface implementation.


Table members

Inherited


Murl.Logic.ITimeframe
Murl.Logic.Stepable

Functions


Murl.Logic.Timeframe.new()

Create a timeframe object.

Murl.SharedPointer.LogicITimeframe new()

Returns
Murl.SharedPointer.LogicITimeframe The created timeframe object, or null if failed.

Murl.Logic.Timeframe.Create()

Create a timeframe object.

Murl.SharedPointer.LogicITimeframe Create()

Returns
Murl.SharedPointer.LogicITimeframe The created timeframe 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 Timeframe::GetStepable() method.

Murl.SharedPointer.LogicIStepable GetStepable()

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

Reset()

Implementation of Timeframe::Reset() method.

Reset()


Start()

Implementation of Timeframe::Start() method.

Start()


Start(endTime)

Implementation of Timeframe::Start(Real endTime) method.

Start(Number endTime)

Parameters
endTimeThe time interval in seconds.

SetCurrentTime(time)

Implementation of Timeframe::SetCurrentTime() method.

Boolean SetCurrentTime(Number time)

Parameters
timeThe current time in seconds.
Returns
Boolean true if successful.

Finish()

Implementation of Timeframe::Finish() method.

Boolean Finish()

Returns
Boolean true if successful.

IsRunning()

Implementation of Timeframe::IsRunning() method.

Boolean IsRunning()

Returns
Boolean true if running.

WasStarted()

Implementation of Timeframe::WasStarted() method.

Boolean WasStarted()

Returns
Boolean true if started.

WasRunning()

Implementation of Timeframe::WasRunning() method.

Boolean WasRunning()

Returns
Boolean true if finished.

IsOrWasRunning()

Implementation of Timeframe::IsOrWasRunning() method.

Boolean IsOrWasRunning()

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

HasPassedTime(time)

Implementation of Timeframe::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.

SetTimeScale(timeScale)

Implementation of Timeframe::SetTimeScale() method.

Boolean SetTimeScale(Number timeScale)

Parameters
timeScaleThe time scale factor.
Returns
Boolean true if successful.

GetTimeScale()

Implementation of Timeframe::GetTimeScale() method.

Number GetTimeScale()

Returns
Number The time scale factor.

SetEndTime(endTime)

Implementation of Timeframe::SetEndTime() method.

Boolean SetEndTime(Number endTime)

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

GetEndTime()

Implementation of Timeframe::GetEndTime() method.

Number GetEndTime()

Returns
Number The end time in seconds.

GetCurrentTime()

Implementation of Timeframe::GetCurrentTime() method.

Number GetCurrentTime()

Returns
Number The current time in seconds.

GetRemainingTime()

Implementation of Timeframe::GetRemainingTime() method.

Number GetRemainingTime()

Returns
Number The remaining time in seconds.