Dragengine.ConversationSystem.CConditionActorParameter Class Reference

Conversation condition comparing value of actor parameter. More...

Inheritance diagram for Dragengine.ConversationSystem.CConditionActorParameter:

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

Public Member Functions
bool	evaluate (ConversationPlayback playback)
	Condition is true.
StringID	getActorID ()
	Actor ID or null if not set.
Operator	getOperator ()
	Operator.
String	getParameter ()
	Name of the parameter.
int	getTestValue ()
	Test value.
String	getTestVariable ()
	Test variable or null to use test value.
CConditionActorParameter	new ()
	Create conversation condition.
CConditionActorParameter	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	setOperator (Operator operator)
	Set operator.
void	setParameter (String parameter)
	Set name of the parameter.
void	setTestValue (int value)
	Set test value.
void	setTestVariable (String variable)
	Set test variable or null to use test value.
void	writeObjectToFile (PersistencyEnvironment env, FileWriter writer)
	Write object to file writer.

Public Attributes
StringID	pActorID
Operator	pOperator
String	pParameter
int	pTestValue
String	pTestVariable

Detailed Description

Conversation condition comparing value of actor parameter.

The default is equal as operator and 0 as test value. If no parameter with the given name exists the value 0 is used as the value of the parameter.

Member Function Documentation

evaluate()

bool Dragengine.ConversationSystem.CConditionActorParameter.evaluate

(

ConversationPlayback

playback

)

Condition is true.

Reimplemented from Dragengine.ConversationSystem.ConversationCondition.

getActorID()

StringID Dragengine.ConversationSystem.CConditionActorParameter.getActorID

(

)

Actor ID or null if not set.

getOperator()

Operator Dragengine.ConversationSystem.CConditionActorParameter.getOperator

(

)

Operator.

getParameter()

String Dragengine.ConversationSystem.CConditionActorParameter.getParameter

(

)

Name of the parameter.

getTestValue()

int Dragengine.ConversationSystem.CConditionActorParameter.getTestValue

(

)

Test value.

getTestVariable()

String Dragengine.ConversationSystem.CConditionActorParameter.getTestVariable

(

)

Test variable or null to use test value.

new() [1/2]

CConditionActorParameter Dragengine.ConversationSystem.CConditionActorParameter.new

(

)

Create conversation condition.

Reimplemented from Dragengine.ConversationSystem.ConversationCondition.

new() [2/2]

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

Read from file.

persistencyFactoryName()

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

(

StringID

id

)

Set actor ID or null if not set.

setOperator()

void Dragengine.ConversationSystem.CConditionActorParameter.setOperator

(

Operator

operator

)

Set operator.

setParameter()

void Dragengine.ConversationSystem.CConditionActorParameter.setParameter

(

String

parameter

)

Set name of the parameter.

setTestValue()

void Dragengine.ConversationSystem.CConditionActorParameter.setTestValue

(

int

value

)

Set test value.

setTestVariable()

void Dragengine.ConversationSystem.CConditionActorParameter.setTestVariable

(

String

variable

)

Set test variable or null to use test value.

writeObjectToFile()

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

Write object to file writer.

Member Data Documentation

pActorID

StringID Dragengine.ConversationSystem.CConditionActorParameter.pActorID

pOperator

Operator Dragengine.ConversationSystem.CConditionActorParameter.pOperator

pParameter

String Dragengine.ConversationSystem.CConditionActorParameter.pParameter

pTestValue

int Dragengine.ConversationSystem.CConditionActorParameter.pTestValue

pTestVariable

String Dragengine.ConversationSystem.CConditionActorParameter.pTestVariable

---

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

• CConditionActorParameter.ds