Dragengine.ConversationSystem.CActionMusic Class Reference

Conversation action changing game music. More...

Inheritance diagram for Dragengine.ConversationSystem.CActionMusic:

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

Public Member Functions
void	execute (ConversationPlayback playback)
	Execute action.
String	getName ()
	Name of music to change.
CActionMusic	new ()
	Create a new conversation action.
CActionMusic	new (PersistencyEnvironment env, FileReader reader)
	Read from file.
String	persistencyFactoryName ()
	Name of PersistencyFactory required to load object from file.
void	setName (String name)
	Set name of music to change.
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
String	pName
Public Attributes inherited from Dragengine.ConversationSystem.ConversationAction
float	pDelay
bool	pWaitForActor
String	pWaitForActorID

Detailed Description

Conversation action changing game music.

Calls ConversationPlayback.changeMusic() with the user defined identifier. It is up to the game script to decide what music to pick and how to change it.

Member Function Documentation

execute()

void Dragengine.ConversationSystem.CActionMusic.execute

(

ConversationPlayback

playback

)

Execute action.

Reimplemented from Dragengine.ConversationSystem.ConversationAction.

getName()

String Dragengine.ConversationSystem.CActionMusic.getName

(

)

Name of music to change.

new() [1/2]

CActionMusic Dragengine.ConversationSystem.CActionMusic.new

(

)

Create a new conversation action.

Reimplemented from Dragengine.ConversationSystem.ConversationAction.

new() [2/2]

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

Read from file.

Reimplemented from Dragengine.ConversationSystem.ConversationAction.

persistencyFactoryName()

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

setName()

void Dragengine.ConversationSystem.CActionMusic.setName

(

String

name

)

Set name of music to change.

writeObjectToFile()

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

Write object to file writer.

Member Data Documentation

pName

String Dragengine.ConversationSystem.CActionMusic.pName

---

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

• CActionMusic.ds