Dragengine.ConversationSystem.CActionSnippet Class Reference

Conversation action processing a different topic if existing. More...

Inheritance diagram for Dragengine.ConversationSystem.CActionSnippet:

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

Public Member Functions
void	execute (ConversationPlayback playback)
	Execute action.
Array	getActions ()
	Array of ConversationAction to run instead of snippet.
bool	getCreateSideLane ()
	Create side lane.
StringID	getGroupID ()
	Group ID.
ConversationActionIterator	getIteratorActions ()
	Actions iterator.
StringID	getTopicID ()
	Topic ID.
CActionSnippet	new ()
	Create conversation action.
CActionSnippet	new (PersistencyEnvironment env, FileReader reader)
	Read from file.
String	persistencyFactoryName ()
	Name of PersistencyFactory required to load object from file.
void	setCreateSideLane (bool createSideLane)
	Set create side lane.
void	setGroupID (StringID id)
	Set group ID.
void	setTopicID (StringID id)
	Set topic ID.
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
bool	pCreateSideLane
StringID	pGroupID
Public Attributes inherited from Dragengine.ConversationSystem.ConversationAction
float	pDelay
bool	pWaitForActor
String	pWaitForActorID

Detailed Description

Conversation action processing a different topic if existing.

Member Function Documentation

execute()

void Dragengine.ConversationSystem.CActionSnippet.execute

(

ConversationPlayback

playback

)

Execute action.

Reimplemented from Dragengine.ConversationSystem.ConversationAction.

getActions()

Array Dragengine.ConversationSystem.CActionSnippet.getActions

(

)

Array of ConversationAction to run instead of snippet.

Version

1.28

For use by simple conversation and custom code wishing to inject actions.

getCreateSideLane()

bool Dragengine.ConversationSystem.CActionSnippet.getCreateSideLane

(

)

Create side lane.

Version

1.28

getGroupID()

StringID Dragengine.ConversationSystem.CActionSnippet.getGroupID

(

)

Group ID.

getIteratorActions()

ConversationActionIterator Dragengine.ConversationSystem.CActionSnippet.getIteratorActions

(

)

Actions iterator.

Version

1.28

getTopicID()

StringID Dragengine.ConversationSystem.CActionSnippet.getTopicID

(

)

Topic ID.

new() [1/2]

CActionSnippet Dragengine.ConversationSystem.CActionSnippet.new

(

)

Create conversation action.

Reimplemented from Dragengine.ConversationSystem.ConversationAction.

new() [2/2]

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

Read from file.

Reimplemented from Dragengine.ConversationSystem.ConversationAction.

persistencyFactoryName()

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

setCreateSideLane()

void Dragengine.ConversationSystem.CActionSnippet.setCreateSideLane

(

bool

createSideLane

)

Set create side lane.

Version

1.28

setGroupID()

void Dragengine.ConversationSystem.CActionSnippet.setGroupID

(

StringID

id

)

Set group ID.

setTopicID()

void Dragengine.ConversationSystem.CActionSnippet.setTopicID

(

StringID

id

)

Set topic ID.

writeObjectToFile()

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

Write object to file writer.

Member Data Documentation

pActions

Array Dragengine.ConversationSystem.CActionSnippet.pActions

pCreateSideLane

bool Dragengine.ConversationSystem.CActionSnippet.pCreateSideLane

pGroupID

StringID Dragengine.ConversationSystem.CActionSnippet.pGroupID

---

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

• CActionSnippet.ds