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

Conversation action sending a command to the game. More...

Inheritance diagram for CActionGameCommand:
ConversationAction Persistable

Classes

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

Public Member Functions

void execute (ConversationPlayback playback)
 Execute action. More...
 
String getCommand ()
 Command to send. More...
 
CActionGameCommand new ()
 Create a new conversation action. More...
 
CActionGameCommand new (PersistencyEnvironment env, FileReader reader)
 Read from file. More...
 
String persistencyFactoryName ()
 Name of PersistencyFactory required to load object from file. More...
 
void setCommand (String command)
 Set command to send. 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 sending a command to the game.

The command is a single text string parsed by the conversation script into an array of arguments and then send to the conversation playback subclass. The format of the command is game specific. It is the responsibility of the game to handle invalid or unknown commands.

Member Function Documentation

◆ execute()

void execute ( ConversationPlayback  playback)

Execute action.

◆ getCommand()

String getCommand ( )

Command to send.

◆ new() [1/2]

Create a new conversation action.

◆ new() [2/2]

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.

◆ setCommand()

void setCommand ( String  command)

Set command to send.

◆ 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: