Drag[en]gine Script Module DragonScript Script API  1.0
CActionPlayerChoice Class Reference
Inheritance diagram for CActionPlayerChoice:
ConversationAction

Public Member Functions

void addAction (ConversationAction action)
 
void addOption (CActionPlayerChoiceOption option)
 
void dispose ()
 
void execute (ConversationPlayback playback)
 
void forEachAction (Block aBlock)
 
void forEachOption (Block aBlock)
 
Array getActions ()
 
Array getActionsForSaveID (int saveID)
 
ConversationActionIterator getIteratorActions ()
 
int getSaveIDForActions (Array actions)
 
String getVariable ()
 
CActionPlayerChoice new ()
 
void setVariable (String variable)
 
- Public Member Functions inherited from ConversationAction
void dispose ()
 
void execute (ConversationPlayback playback)
 
Array getActionsForSaveID (int saveID)
 
float getDelay ()
 
int getSaveIDForActions (Array actions)
 
int getWaitForActorSpeak ()
 
ConversationAction new ()
 
void setDelay (float delay)
 
void setWaitForActorSpeak (int actor)
 

Detailed Description

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

Author
Roland Pl├╝ss
Version
1.0

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 the action.

§ forEachAction()

void forEachAction ( Block  aBlock)

Visits all actions.

§ forEachOption()

void forEachOption ( Block  aBlock)

Visits all options.

§ getActions()

Array getActions ( )

Retrieves the actions.

§ getActionsForSaveID()

Array getActionsForSaveID ( int  saveID)

For loading retrieves the actions array matching a given unique number or null if not found.

§ getIteratorActions()

ConversationActionIterator getIteratorActions ( )

Retrieves iterator for actions.

§ getSaveIDForActions()

int getSaveIDForActions ( Array  actions)

For saving determines a unique number to identify the given actions array with or -1 if not found.

§ getVariable()

String getVariable ( )

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

§ new()

Create a new conversation action.

§ setVariable()

void setVariable ( String  variable)

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


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