Dragengine.ConversationSystem.CActionSetActorParameter Class Reference

Conversation action setting an actor parameter. More...

Inheritance diagram for Dragengine.ConversationSystem.CActionSetActorParameter:

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

Public Member Functions
void	execute (ConversationPlayback playback)
	Execute action. More...
StringID	getActorID ()
	Actor ID or null if not set. More...
String	getName ()
	Name of the parameter to set. More...
Operator	getOperator ()
	Operator. More...
int	getValue ()
	Value to use for operation. More...
String	getValueVariable ()
	Variable value to use for operation or null to use value. More...
CActionSetActorParameter	new ()
	Create conversation action. More...
CActionSetActorParameter	new (PersistencyEnvironment env, FileReader reader)
	Read from file. More...
String	persistencyFactoryName ()
	Name of PersistencyFactory required to load object from file. More...
void	setActorID (StringID id)
	Set actor ID or null if not set. More...
void	setName (String name)
	Set name of the parameter to set. More...
void	setOperator (Operator operator)
	Set operator. More...
void	setValue (int value)
	Set value to use for operation. More...
void	setValueVariable (String variable)
	Set variable value to use for operation or null to use value. More...
void	writeObjectToFile (PersistencyEnvironment env, FileWriter writer)
	Write object to file writer. More...
Public Member Functions inherited from Dragengine.ConversationSystem.ConversationAction
float	getDelay ()
	Delay in seconds before processing this action. More...
bool	getWaitForActor ()
	Wait for actor. More...
String	getWaitForActorID ()
	ID of actor to wait for or null to wait for all actors. More...
void	setDelay (float delay)
	Set delay in seconds before processing this action. More...
void	setWaitForActor (bool wait)
	Set wait for actor. More...
void	setWaitForActorID (String id)
	Set ID of actor to wait for or null to wait for all actors. More...

Public Attributes
StringID	pActorID
String	pName
Operator	pOperator
int	pValue
String	pValueVariable
Public Attributes inherited from Dragengine.ConversationSystem.ConversationAction
float	pDelay
	Delay before processing the action. More...
bool	pWaitForActor
	Wait for actor. More...
String	pWaitForActorID
	ID of actor to wait for or null to wait for all actors. More...

Detailed Description

Conversation action setting an actor parameter.

Member Function Documentation

execute()

void Dragengine.ConversationSystem.CActionSetActorParameter.execute

(

ConversationPlayback

playback

)

Execute action.

Reimplemented from Dragengine.ConversationSystem.ConversationAction.

getActorID()

StringID Dragengine.ConversationSystem.CActionSetActorParameter.getActorID

(

)

Actor ID or null if not set.

getName()

String Dragengine.ConversationSystem.CActionSetActorParameter.getName

(

)

Name of the parameter to set.

getOperator()

Operator Dragengine.ConversationSystem.CActionSetActorParameter.getOperator

(

)

Operator.

getValue()

int Dragengine.ConversationSystem.CActionSetActorParameter.getValue

(

)

Value to use for operation.

getValueVariable()

String Dragengine.ConversationSystem.CActionSetActorParameter.getValueVariable

(

)

Variable value to use for operation or null to use value.

new() [1/2]

CActionSetActorParameter Dragengine.ConversationSystem.CActionSetActorParameter.new

(

)

Create conversation action.

Reimplemented from Dragengine.ConversationSystem.ConversationAction.

new() [2/2]

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

Read from file.

Reimplemented from Dragengine.ConversationSystem.ConversationAction.

persistencyFactoryName()

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

Implements Dragengine.LoadSave.Persistable.

setActorID()

void Dragengine.ConversationSystem.CActionSetActorParameter.setActorID

(

StringID

id

)

Set actor ID or null if not set.

setName()

void Dragengine.ConversationSystem.CActionSetActorParameter.setName

(

String

name

)

Set name of the parameter to set.

setOperator()

void Dragengine.ConversationSystem.CActionSetActorParameter.setOperator

(

Operator

operator

)

Set operator.

setValue()

void Dragengine.ConversationSystem.CActionSetActorParameter.setValue

(

int

value

)

Set value to use for operation.

setValueVariable()

void Dragengine.ConversationSystem.CActionSetActorParameter.setValueVariable

(

String

variable

)

Set variable value to use for operation or null to use value.

writeObjectToFile()

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

Write object to file writer.

Implements Dragengine.LoadSave.Persistable.

Member Data Documentation

pActorID

StringID Dragengine.ConversationSystem.CActionSetActorParameter.pActorID

pName

String Dragengine.ConversationSystem.CActionSetActorParameter.pName

pOperator

Operator Dragengine.ConversationSystem.CActionSetActorParameter.pOperator

pValue

int Dragengine.ConversationSystem.CActionSetActorParameter.pValue

pValueVariable

String Dragengine.ConversationSystem.CActionSetActorParameter.pValueVariable

---

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

• CActionSetActorParameter.ds