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

The IStageTimeline interface.

The IStageTimeline encapsulates a reference to a Graph::ITimeline, an intro and an outro (start / end) time pair.
This object is typically used by the IStage object to create an intro and outro animation behaviour for stages.
(!) Do not confuse with Graph::ITimeline intro / loop / outro feature. When using StartIntro() or StartOutro() the Graph::ITimeline is simply started with the corresponding (start / end) time pair by calling Graph::ITimeline::Start(Real startTime, Real endTime).


Table members

Methods


SetIntroStartTime(startTime)

Set the intro start time.

SetIntroStartTime(Number startTime)

Parameters
startTimeThe intro start time in seconds.

SetIntroEndTime(endTime)

Set the intro end time.

SetIntroEndTime(Number endTime)

Parameters
endTimeThe intro end time in seconds.

SetIntroTime(startTime, endTime)

Set the intro start and end time.

SetIntroTime(Number startTime, Number endTime)

Parameters
startTimeThe intro start time in seconds.
endTimeThe intro end time in seconds.

GetIntroStartTime()

Get the intro start time.

Number GetIntroStartTime()

Returns
Number The intro start time in seconds.

GetIntroEndTime()

Get the intro end time.

Number GetIntroEndTime()

Returns
Number The intro end time in seconds.

SetOutroStartTime(startTime)

Set the outro start time.

SetOutroStartTime(Number startTime)

Parameters
startTimeThe outro start time in seconds.

SetOutroEndTime(endTime)

Set the outro end time.

SetOutroEndTime(Number endTime)

Parameters
endTimeThe outro end time in seconds.

SetOutroTime(startTime, endTime)

Set the outro start and end time.

SetOutroTime(Number startTime, Number endTime)

Parameters
startTimeThe outro start time in seconds.
endTimeThe outro end time in seconds.

GetOutroStartTime()

Get the outro start time.

Number GetOutroStartTime()

Returns
Number The outro start time in seconds.

GetOutroEndTime()

Get the outro end time.

Number GetOutroEndTime()

Returns
Number The outro end time in seconds.

GetTimeline()

Get the Graph::ITimeline object.

Murl.Graph.ITimeline GetTimeline()

Returns
Murl.Graph.ITimeline The Graph::ITimeline object.

Init(root, timeline)

Initialize the IStageTimeline object.

Boolean Init(Murl.Graph.IRoot root, String timeline)

Parameters
rootThe graph root node.
timelineThe full path to the graph <Timeline> instance.
Returns
Boolean true if successful.

DeInit()

Deinitialize the IStageTimeline object.

Boolean DeInit()

Returns
Boolean true if successful.

StartIntro()

Start the intro.

Boolean StartIntro()

Returns
Boolean true if successful.

StartOutro()

Start the outro.

Boolean StartOutro()

Returns
Boolean true if successful.

IsRunning()

Check if the timeline is running.

Boolean IsRunning()

Returns
Boolean true if running.