Dragengine.ConversationSystem.CActionActorAdd Class Reference

Conversation action adding an actor to the conversation if not there yet. More...

Inheritance diagram for Dragengine.ConversationSystem.CActionActorAdd:

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

Public Member Functions
void	execute (ConversationPlayback playback)
	Execute action.
StringID	getActorID ()
	Actor ID or null if not set.
StringID	getAliasID ()
	Optional alias ID to set for the actor or null if not set.
CActionActorAdd	new ()
	Create conversation action.
CActionActorAdd	new (PersistencyEnvironment env, FileReader reader)
	Read from file.
String	persistencyFactoryName ()
	Name of PersistencyFactory required to load object from file.
void	setActorID (StringID id)
	Set actor ID or null if not set.
void	setAliasID (StringID id)
	Set optional alias ID to set for the actor or null if not set.
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
StringID	pActorID
StringID	pAliasID
Public Attributes inherited from Dragengine.ConversationSystem.ConversationAction
float	pDelay
bool	pWaitForActor
String	pWaitForActorID

Detailed Description

Conversation action adding an actor to the conversation if not there yet.

Member Function Documentation

execute()

void Dragengine.ConversationSystem.CActionActorAdd.execute

(

ConversationPlayback

playback

)

Execute action.

Reimplemented from Dragengine.ConversationSystem.ConversationAction.

getActorID()

StringID Dragengine.ConversationSystem.CActionActorAdd.getActorID

(

)

Actor ID or null if not set.

getAliasID()

StringID Dragengine.ConversationSystem.CActionActorAdd.getAliasID

(

)

Optional alias ID to set for the actor or null if not set.

new() [1/2]

CActionActorAdd Dragengine.ConversationSystem.CActionActorAdd.new

(

)

Create conversation action.

Reimplemented from Dragengine.ConversationSystem.ConversationAction.

new() [2/2]

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

Read from file.

Reimplemented from Dragengine.ConversationSystem.ConversationAction.

persistencyFactoryName()

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

setActorID()

void Dragengine.ConversationSystem.CActionActorAdd.setActorID

(

StringID

id

)

Set actor ID or null if not set.

setAliasID()

void Dragengine.ConversationSystem.CActionActorAdd.setAliasID

(

StringID

id

)

Set optional alias ID to set for the actor or null if not set.

writeObjectToFile()

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

Write object to file writer.

Member Data Documentation

pActorID

StringID Dragengine.ConversationSystem.CActionActorAdd.pActorID

pAliasID

StringID Dragengine.ConversationSystem.CActionActorAdd.pAliasID

---

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

• CActionActorAdd.ds