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

Conversation action sending a command to an actor. More...

Inheritance diagram for CActionActorCommand:
ConversationAction Persistable

Classes

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

Public Member Functions

void execute (ConversationPlayback playback)
 Execute action. More...
 
StringID getActorID ()
 Actor ID or null if not set. More...
 
int getActorIndex ()
 Actor index or -1 if not set. More...
 
String getCommand ()
 Command to send. More...
 
CActionActorCommand new ()
 Create conversation action. More...
 
CActionActorCommand new (PersistencyEnvironment env, FileReader reader)
 Read from file. More...
 
String persistencyFactoryName ()
 Name of PersistencyFactory required to load object from file. More...
 
void setActorID (StringID id)
 Set actor ID or null if not set. More...
 
void setActorIndex (int index)
 Set actor index or -1 if not set. 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 an actor.

The command is a single text string parsed by the conversation script into an array of arguments and then send to the player action. The format of the command depends on the type of the player action the actor is using at the time of the command being send. If the command is not understood or improperly formatted the player action does nothing. Thus it is important to ensure make sure this action is used in the proper situation.

Member Function Documentation

◆ execute()

void execute ( ConversationPlayback  playback)

Execute action.

◆ getActorID()

StringID getActorID ( )

Actor ID or null if not set.

◆ getActorIndex()

int getActorIndex ( )

Actor index or -1 if not set.

◆ getCommand()

String getCommand ( )

Command to send.

◆ new() [1/2]

Create 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.

◆ setActorID()

void setActorID ( StringID  id)

Set actor ID or null if not set.

◆ setActorIndex()

void setActorIndex ( int  index)

Set actor index or -1 if not set.

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