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

Conversation action setting an actor parameter. More...

Inheritance diagram for CActionSetActorParameter:
ConversationAction Persistable

Classes

enum  eOperators
 Operator. More...
 
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 getName ()
 Name of the parameter to set. More...
 
int getOperator ()
 Operator. More...
 
int getValue ()
 Value to set the parameter to. More...
 
CActionSetActorParameter new ()
 Create conversation action. More...
 
CActionSetActorParameter 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 setName (String name)
 Set name of the parameter to set. More...
 
void setOperator (int operator)
 Set operator. More...
 
void setValue (int value)
 Set value to set the parameter to. 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 setting an actor parameter.

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.

◆ getName()

String getName ( )

Name of the parameter to set.

◆ getOperator()

int getOperator ( )

Operator.

◆ getValue()

int getValue ( )

Value to set the parameter to.

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

◆ setName()

void setName ( String  name)

Set name of the parameter to set.

◆ setOperator()

void setOperator ( int  operator)

Set operator.

◆ setValue()

void setValue ( int  value)

Set value to set the parameter to.

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