![]() |
Murl Engine Lua Addon API
Version 1.0 beta
|
The IStageProcessor interface.
The IStageProcessor is handling a set of IStage objects. The IStage::RunState is controlled by the IStageProcessor.
Optional a graph <Switch> identifier can be specified to automatically select a sub graph attached to a switch child. The graph switch identifier must be set by SetSwitchNodeId() and each IStage registered to the IStageHandler can specify a switch identifier for selecting the active child of the switch at IStage::RUN_STATE_BEGIN_INTRO.
Additional IProcessor objects can be added to the IStageProcessor object by using myStageProc->GetProcessor(myStageProc)->AddChild(). The IProcessor (OnInit, OnProcessTick, OnProcessFrame) is always executed before the stage execution.
Get the processor interface from a stage-processor object. The IStageProcessor conforms to the IProcessor interface.
Murl.SharedPointer.LogicIProcessor GetProcessor()
Add a stage object.
Boolean AddStage(Murl.SharedPointer.LogicIStage stage)
stage | The stage object to add. |
Remove a stage object.
Boolean RemoveStage(Murl.SharedPointer.LogicIStage stage)
stage | The stage object to remove. |
Initialize and add a stage object.
Boolean InitAddStage(Murl.Logic.IState state, Murl.SharedPointer.LogicIStage stage)
state | The IState object. |
stage | The stage object to initialize and add. |
Remove and deinitialize a stage object.
Boolean RemoveDeInitStage(Murl.Logic.IState state, Murl.SharedPointer.LogicIStage stage)
state | The IState object. |
stage | The stage object to deinitialize and remove. |
Set the graph switch node identifier. Must be set before the stage processor is initialized.
Boolean SetSwitchNodeId(String switchNodeId)
switchNodeId | The full path to the graph <Switch> instance. |
Get the graph switch node identifier.
String GetSwitchNodeId()
Get a stage object by name.
Murl.SharedPointer.LogicIStage GetStage(String stageId)
stageId | The identifier of the stage to get. |
Set the current run state of a stage.
Boolean SetStageRunState(String stageId, Murl.Logic.IStage.RunState runState)
stageId | The identifier of the stage to modify. |
runState | The run state to set. |
Check if any stage's IStageTimeline is running.
Boolean IsAnyTimelineRunning()
Start a stage intro. Execute the IStage::StartStageIntro() method.
Boolean StartIntro(String stageId)
stageId | The identifier of the stage to start. |
Start a stage intro and set the IStageTimeline intro start time. Execute the IStage::StartStageIntro() method.
Boolean StartIntro(String stageId, Number startTime)
stageId | The identifier of the stage to start. |
startTime | The IStageTimeline intro start time. |
Start a stage intro and set the IStageTimeline intro (start / end) time. Execute the IStage::StartStageIntro() method.
Boolean StartIntro(String stageId, Number startTime, Number endTime)
stageId | The identifier of the stage to start. |
startTime | The IStageTimeline intro start time. |
endTime | The IStageTimeline intro end time. |
Start a stage outro. Execute the IStage::StartStageOutro() method.
Boolean StartOutro(String stageId)
stageId | The identifier of the stage to start. |
Start a stage outro and set the IStageTimeline outro end time. Execute the IStage::StartStageOutro() method.
Boolean StartOutro(String stageId, Number endTime)
stageId | The identifier of the stage to start. |
endTime | The IStageTimeline outro end time. |
Start a stage outro and set the IStageTimeline outro (start / end) time. Execute the IStage::StartStageOutro() method.
Boolean StartOutro(String stageId, Number startTime, Number endTime)
stageId | The identifier of the stage to start. |
startTime | The IStageTimeline outro start time. |
endTime | The IStageTimeline outro end time. |