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

Conversation action presenting the player with a list of options to select one from. More...

Inheritance diagram for CActionPlayerChoice:
ConversationAction Persistable

Classes

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

Public Member Functions

void addAction (ConversationAction action)
 Adds an action. More...
 
void addOption (CActionPlayerChoiceOption option)
 Adds an option. More...
 
void dispose ()
 Dispose of the action. More...
 
void execute (ConversationPlayback playback)
 Execute action. More...
 
void forEachAction (Block aBlock)
 Visits all actions. More...
 
void forEachOption (Block aBlock)
 Visits all options. More...
 
Array getActions ()
 Actions. More...
 
ConversationActionIterator getIteratorActions ()
 Iterator for actions. More...
 
String getVariable ()
 Name of variable to set with the selected option or null if not used. More...
 
CActionPlayerChoice new ()
 Create conversation action. More...
 
CActionPlayerChoice new (PersistencyEnvironment env, FileReader reader)
 Read from file. More...
 
String persistencyFactoryName ()
 Name of PersistencyFactory required to load object from file. More...
 
void setVariable (String variable)
 Set name of variable to set with the selected option or null if not used. 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 presenting the player with a list of options to select one from.

Member Function Documentation

◆ addAction()

void addAction ( ConversationAction  action)

Adds an action.

◆ addOption()

void addOption ( CActionPlayerChoiceOption  option)

Adds an option.

◆ dispose()

void dispose ( )

Dispose of the action.

◆ execute()

void execute ( ConversationPlayback  playback)

Execute action.

◆ forEachAction()

void forEachAction ( Block  aBlock)

Visits all actions.

◆ forEachOption()

void forEachOption ( Block  aBlock)

Visits all options.

◆ getActions()

Array getActions ( )

Actions.

◆ getIteratorActions()

ConversationActionIterator getIteratorActions ( )

Iterator for actions.

◆ getVariable()

String getVariable ( )

Name of variable to set with the selected option or null if not used.

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

◆ setVariable()

void setVariable ( String  variable)

Set name of variable to set with the selected option or null if not used.

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