Dragengine.ConversationSystem.CActionPlayerChoice Class Reference

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

Inheritance diagram for Dragengine.ConversationSystem.CActionPlayerChoice:

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

Public Member Functions
void	addAction (ConversationAction action)
	Adds an action.
void	addOption (CActionPlayerChoiceOption option)
	Adds an option.
void	execute (ConversationPlayback playback)
	Execute action.
void	forEachAction (Block aBlock)
	Visits all actions.
void	forEachOption (Block aBlock)
	Visits all options.
Array	getActions ()
	Actions.
ConversationActionIterator	getIteratorActions ()
	Iterator for actions.
CActionPlayerChoiceOption	getOptionAt (int index)
	Option at index.
int	getOptionCount ()
	Number of options.
String	getVariable ()
	Name of variable to set with the selected option or null if not used.
CActionPlayerChoice	new ()
	Create conversation action.
CActionPlayerChoice	new (PersistencyEnvironment env, FileReader reader)
	Read from file.
String	persistencyFactoryName ()
	Name of PersistencyFactory required to load object from file.
void	setVariable (String variable)
	Set name of variable to set with the selected option or null if not used.
void	writeObjectToFile (PersistencyEnvironment env, FileWriter writer)
	Write object to file writer.
Public Member Functions inherited from Dragengine.ConversationSystem.ConversationAction
float	getDelay ()
	Delay in seconds before processing this action.
bool	getWaitForActor ()
	Wait for actor.
String	getWaitForActorID ()
	ID of actor to wait for or null to wait for all actors.
bool	getWaitSpeakOnly ()
	Waiting considers only actor speaking not actor waiting.
void	setDelay (float delay)
	Set delay in seconds before processing this action.
void	setWaitForActor (bool wait)
	Set wait for actor.
void	setWaitForActorID (String id)
	Set ID of actor to wait for or null to wait for all actors.
void	setWaitSpeakOnly (bool speakOnly)
	Set waiting considers only actor speaking not actor waiting.

Public Attributes
Array	pActions
Array	pOptions
String	pVariable
Public Attributes inherited from Dragengine.ConversationSystem.ConversationAction
float	pDelay
bool	pWaitForActor
String	pWaitForActorID

Detailed Description

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

Member Function Documentation

addAction()

void Dragengine.ConversationSystem.CActionPlayerChoice.addAction

(

ConversationAction

action

)

Adds an action.

addOption()

void Dragengine.ConversationSystem.CActionPlayerChoice.addOption

(

CActionPlayerChoiceOption

option

)

Adds an option.

execute()

void Dragengine.ConversationSystem.CActionPlayerChoice.execute

(

ConversationPlayback

playback

)

Execute action.

Reimplemented from Dragengine.ConversationSystem.ConversationAction.

forEachAction()

void Dragengine.ConversationSystem.CActionPlayerChoice.forEachAction

(

Block

aBlock

)

Visits all actions.

forEachOption()

void Dragengine.ConversationSystem.CActionPlayerChoice.forEachOption

(

Block

aBlock

)

Visits all options.

getActions()

Array Dragengine.ConversationSystem.CActionPlayerChoice.getActions

(

)

Actions.

getIteratorActions()

ConversationActionIterator Dragengine.ConversationSystem.CActionPlayerChoice.getIteratorActions

(

)

Iterator for actions.

getOptionAt()

CActionPlayerChoiceOption Dragengine.ConversationSystem.CActionPlayerChoice.getOptionAt

(

int

index

)

Option at index.

getOptionCount()

int Dragengine.ConversationSystem.CActionPlayerChoice.getOptionCount

(

)

Number of options.

getVariable()

String Dragengine.ConversationSystem.CActionPlayerChoice.getVariable

(

)

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

new() [1/2]

CActionPlayerChoice Dragengine.ConversationSystem.CActionPlayerChoice.new

(

)

Create conversation action.

Reimplemented from Dragengine.ConversationSystem.ConversationAction.

new() [2/2]

CActionPlayerChoice Dragengine.ConversationSystem.CActionPlayerChoice.new	(	PersistencyEnvironment	env,
		FileReader	reader
	)

Read from file.

Reimplemented from Dragengine.ConversationSystem.ConversationAction.

persistencyFactoryName()

String Dragengine.ConversationSystem.CActionPlayerChoice.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.

setVariable()

void Dragengine.ConversationSystem.CActionPlayerChoice.setVariable

(

String

variable

)

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

writeObjectToFile()

void Dragengine.ConversationSystem.CActionPlayerChoice.writeObjectToFile	(	PersistencyEnvironment	env,
		FileWriter	writer
	)

Write object to file writer.

Member Data Documentation

pActions

Array Dragengine.ConversationSystem.CActionPlayerChoice.pActions

pOptions

Array Dragengine.ConversationSystem.CActionPlayerChoice.pOptions

pVariable

String Dragengine.ConversationSystem.CActionPlayerChoice.pVariable

---

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

• CActionPlayerChoice.ds