Drag[en]gine Script Module DragonScript  1.23
Dragengine.ConversationSystem.ConversationPlaybackLayer Class Reference

Layer in a conversation playback. More...

Inheritance diagram for Dragengine.ConversationSystem.ConversationPlaybackLayer:

Public Member Functions

void advance ()
 Advance to the next action if possible. More...
 
void cancelLooping ()
 Cancel looping. More...
 
void forwardEnd ()
 Forward to end. More...
 
void forwardFirst ()
 Forward to first action. More...
 
void forwardLast ()
 Forward to last action. More...
 
ConversationCondition getLoopCondition ()
 Loop condition or null if always true. More...
 
float getLoopEvalConditionInterval ()
 Interval to wait before testing the condition again to improve performance. More...
 
bool getLooping ()
 Actions are looping. More...
 
ConversationAction getNextAction ()
 Next action or null if at the end of the current list. More...
 
bool getTopicTopLevel ()
 Belongs to top level of a topic. More...
 
bool hasNextAction ()
 Not at end of list. More...
 
ConversationPlaybackLayer new (ConversationActionIterator iterator)
 Create a new layer. More...
 
ConversationPlaybackLayer new (ConversationActionIterator iterator, bool advance)
 Create a new layer. More...
 
void setLoopCondition (ConversationCondition condition)
 Set loop condition or null if always true. More...
 
void setLoopEvalConditionInterval (float interval)
 Set interval to wait before testing the condition again to improve performance. More...
 
void setLooping (bool looping)
 Set actions are looping. More...
 
void setTopicTopLevel (bool topicTopLevel)
 Set if layer belongs to top level of a topic. More...
 
void writeToFile (PersistencyEnvironment env, FileWriter writer)
 Write layer to file. More...
 

Static Public Member Functions

static ConversationPlaybackLayer readFromFile (PersistencyEnvironment env, FileReader reader)
 Read layer from file. More...
 

Public Attributes

ConversationActionIterator pActionIterator
 
ConversationCondition pLoopCondition
 
float pLoopEvalConditionInterval
 
bool pLooping
 
ConversationAction pNextAction
 
bool pTopicTopLevel
 

Detailed Description

Layer in a conversation playback.

Member Function Documentation

◆ advance()

void Dragengine.ConversationSystem.ConversationPlaybackLayer.advance ( )

Advance to the next action if possible.

◆ cancelLooping()

void Dragengine.ConversationSystem.ConversationPlaybackLayer.cancelLooping ( )

Cancel looping.

◆ forwardEnd()

void Dragengine.ConversationSystem.ConversationPlaybackLayer.forwardEnd ( )

Forward to end.

◆ forwardFirst()

void Dragengine.ConversationSystem.ConversationPlaybackLayer.forwardFirst ( )

Forward to first action.

◆ forwardLast()

void Dragengine.ConversationSystem.ConversationPlaybackLayer.forwardLast ( )

Forward to last action.

◆ getLoopCondition()

ConversationCondition Dragengine.ConversationSystem.ConversationPlaybackLayer.getLoopCondition ( )

Loop condition or null if always true.

◆ getLoopEvalConditionInterval()

float Dragengine.ConversationSystem.ConversationPlaybackLayer.getLoopEvalConditionInterval ( )

Interval to wait before testing the condition again to improve performance.

◆ getLooping()

bool Dragengine.ConversationSystem.ConversationPlaybackLayer.getLooping ( )

Actions are looping.

◆ getNextAction()

ConversationAction Dragengine.ConversationSystem.ConversationPlaybackLayer.getNextAction ( )

Next action or null if at the end of the current list.

◆ getTopicTopLevel()

bool Dragengine.ConversationSystem.ConversationPlaybackLayer.getTopicTopLevel ( )

Belongs to top level of a topic.

◆ hasNextAction()

bool Dragengine.ConversationSystem.ConversationPlaybackLayer.hasNextAction ( )

Not at end of list.

◆ new() [1/2]

ConversationPlaybackLayer Dragengine.ConversationSystem.ConversationPlaybackLayer.new ( ConversationActionIterator  iterator)

Create a new layer.

Sets the next action to the first iterator action and advances the iterator.

◆ new() [2/2]

ConversationPlaybackLayer Dragengine.ConversationSystem.ConversationPlaybackLayer.new ( ConversationActionIterator  iterator,
bool  advance 
)

Create a new layer.

Parameters
iteratorAction iterator to use.
advanceIf true sets the next action to the first iterator action and advances the iterator. If false the iterator is not advanced and the next action is set to null.

◆ readFromFile()

static ConversationPlaybackLayer Dragengine.ConversationSystem.ConversationPlaybackLayer.readFromFile ( PersistencyEnvironment  env,
FileReader  reader 
)
static

Read layer from file.

◆ setLoopCondition()

void Dragengine.ConversationSystem.ConversationPlaybackLayer.setLoopCondition ( ConversationCondition  condition)

Set loop condition or null if always true.

◆ setLoopEvalConditionInterval()

void Dragengine.ConversationSystem.ConversationPlaybackLayer.setLoopEvalConditionInterval ( float  interval)

Set interval to wait before testing the condition again to improve performance.

◆ setLooping()

void Dragengine.ConversationSystem.ConversationPlaybackLayer.setLooping ( bool  looping)

Set actions are looping.

◆ setTopicTopLevel()

void Dragengine.ConversationSystem.ConversationPlaybackLayer.setTopicTopLevel ( bool  topicTopLevel)

Set if layer belongs to top level of a topic.

◆ writeToFile()

void Dragengine.ConversationSystem.ConversationPlaybackLayer.writeToFile ( PersistencyEnvironment  env,
FileWriter  writer 
)

Write layer to file.

Member Data Documentation

◆ pActionIterator

ConversationActionIterator Dragengine.ConversationSystem.ConversationPlaybackLayer.pActionIterator

◆ pLoopCondition

ConversationCondition Dragengine.ConversationSystem.ConversationPlaybackLayer.pLoopCondition

◆ pLoopEvalConditionInterval

float Dragengine.ConversationSystem.ConversationPlaybackLayer.pLoopEvalConditionInterval

◆ pLooping

bool Dragengine.ConversationSystem.ConversationPlaybackLayer.pLooping

◆ pNextAction

ConversationAction Dragengine.ConversationSystem.ConversationPlaybackLayer.pNextAction

◆ pTopicTopLevel

bool Dragengine.ConversationSystem.ConversationPlaybackLayer.pTopicTopLevel

The documentation for this class was generated from the following file: