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

Conversation action waiting for condition to become false while looping actions. More...

Inheritance diagram for Dragengine.ConversationSystem.CActionWait:
Dragengine.ConversationSystem.ConversationAction Dragengine.LoadSave.Persistable

Classes

class  Factory
 Factory for loading actor actions. More...
 

Public Member Functions

void addAction (ConversationAction action)
 Add action. More...
 
void execute (ConversationPlayback playback)
 Execute action. More...
 
void forEachAction (Block aBlock)
 Visits actions. More...
 
ConversationCondition getCondition ()
 Condition or null to skip action. More...
 
float getInterval ()
 Interval to wait before testing the condition again to improve performance. More...
 
ConversationActionIterator getIteratorActions ()
 Actions to loop while condition is true. More...
 
CActionWait new ()
 Create conversation action. More...
 
CActionWait new (PersistencyEnvironment env, FileReader reader)
 Read from file. More...
 
String persistencyFactoryName ()
 Name of PersistencyFactory required to load object from file. More...
 
void setCondition (ConversationCondition condition)
 Set condition or null to skip action. More...
 
void setInterval (float interval)
 Set interval to wait before testing the condition again to improve performance. More...
 
void writeObjectToFile (PersistencyEnvironment env, FileWriter writer)
 Write object to file writer. More...
 
- Public Member Functions inherited from Dragengine.ConversationSystem.ConversationAction
float getDelay ()
 Delay in seconds before processing this action. More...
 
bool getWaitForActor ()
 Wait for actor. More...
 
String getWaitForActorID ()
 ID of actor to wait for or null to wait for all actors. More...
 
void setDelay (float delay)
 Set delay in seconds before processing this action. More...
 
void setWaitForActor (bool wait)
 Set wait for actor. More...
 
void setWaitForActorID (String id)
 Set ID of actor to wait for or null to wait for all actors. More...
 

Public Attributes

Array pActions
 
ConversationCondition pCondition
 
float pInterval
 
- Public Attributes inherited from Dragengine.ConversationSystem.ConversationAction
float pDelay
 Delay before processing the action. More...
 
bool pWaitForActor
 Wait for actor. More...
 
String pWaitForActorID
 ID of actor to wait for or null to wait for all actors. More...
 

Detailed Description

Conversation action waiting for condition to become false while looping actions.

Member Function Documentation

◆ addAction()

void Dragengine.ConversationSystem.CActionWait.addAction ( ConversationAction  action)

Add action.

◆ execute()

void Dragengine.ConversationSystem.CActionWait.execute ( ConversationPlayback  playback)

Execute action.

Reimplemented from Dragengine.ConversationSystem.ConversationAction.

◆ forEachAction()

void Dragengine.ConversationSystem.CActionWait.forEachAction ( Block  aBlock)

Visits actions.

◆ getCondition()

ConversationCondition Dragengine.ConversationSystem.CActionWait.getCondition ( )

Condition or null to skip action.

◆ getInterval()

float Dragengine.ConversationSystem.CActionWait.getInterval ( )

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

◆ getIteratorActions()

ConversationActionIterator Dragengine.ConversationSystem.CActionWait.getIteratorActions ( )

Actions to loop while condition is true.

◆ new() [1/2]

CActionWait Dragengine.ConversationSystem.CActionWait.new ( )

Create conversation action.

Reimplemented from Dragengine.ConversationSystem.ConversationAction.

◆ new() [2/2]

CActionWait Dragengine.ConversationSystem.CActionWait.new ( PersistencyEnvironment  env,
FileReader  reader 
)

Read from file.

Reimplemented from Dragengine.ConversationSystem.ConversationAction.

◆ persistencyFactoryName()

String Dragengine.ConversationSystem.CActionWait.persistencyFactoryName ( )

Name of PersistencyFactory required to load object from file.

Name of PersistencyFactory is first written to the file as string with 8-bit length. Then writeToFile() is called to write the object itself. Empty name is not allowed as is names longer than 255 characters. Name has to match a PersistencyFactory present in the Persistency instance used for loading objects. Object is read using PersistencyFactory.readObjectFromFile() of the matching PersistencyFactory.

Implements Dragengine.LoadSave.Persistable.

◆ setCondition()

void Dragengine.ConversationSystem.CActionWait.setCondition ( ConversationCondition  condition)

Set condition or null to skip action.

◆ setInterval()

void Dragengine.ConversationSystem.CActionWait.setInterval ( float  interval)

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

◆ writeObjectToFile()

void Dragengine.ConversationSystem.CActionWait.writeObjectToFile ( PersistencyEnvironment  env,
FileWriter  writer 
)

Write object to file writer.

Implements Dragengine.LoadSave.Persistable.

Member Data Documentation

◆ pActions

Array Dragengine.ConversationSystem.CActionWait.pActions

◆ pCondition

ConversationCondition Dragengine.ConversationSystem.CActionWait.pCondition

◆ pInterval

float Dragengine.ConversationSystem.CActionWait.pInterval

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