Drag[en]gine Script Module DragonScript Script API  1.0
CActionWait Class Reference

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

Inheritance diagram for CActionWait:
ConversationAction Persistable

Classes

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

Public Member Functions

void addAction (ConversationAction action)
 Add action. More...
 
void dispose ()
 Dispose of 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 ConversationAction
void dispose ()
 Dispose of action. More...
 
void execute (ConversationPlayback playback)
 Execute the action. More...
 
float getDelay ()
 Delay in seconds before processing this action. More...
 
int getWaitForActorSpeak ()
 Actor to wait speaking for or -1 for no wait. More...
 
ConversationAction new ()
 Create conversation action. More...
 
ConversationAction new (PersistencyEnvironment env, FileReader reader)
 Read from file. More...
 
void setDelay (float delay)
 Set delay in seconds before processing this action. More...
 
void setWaitForActorSpeak (int actor)
 Set actor to wait speaking for or -1 for no wait. More...
 

Detailed Description

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

Member Function Documentation

◆ addAction()

void addAction ( ConversationAction  action)

Add action.

◆ dispose()

void dispose ( )

Dispose of action.

◆ execute()

void execute ( ConversationPlayback  playback)

Execute action.

◆ forEachAction()

void forEachAction ( Block  aBlock)

Visits actions.

◆ getCondition()

ConversationCondition getCondition ( )

Condition or null to skip action.

◆ getInterval()

float getInterval ( )

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

◆ getIteratorActions()

ConversationActionIterator getIteratorActions ( )

Actions to loop while condition is true.

◆ new() [1/2]

CActionWait new ( )

Create conversation action.

◆ new() [2/2]

CActionWait new ( PersistencyEnvironment  env,
FileReader  reader 
)

Read from file.

◆ persistencyFactoryName()

String 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 Persistable.

◆ setCondition()

void setCondition ( ConversationCondition  condition)

Set condition or null to skip action.

◆ setInterval()

void setInterval ( float  interval)

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

◆ writeObjectToFile()

void writeObjectToFile ( PersistencyEnvironment  env,
FileWriter  writer 
)

Write object to file writer.

Implements Persistable.


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