Drag[en]gine Script Module DragonScript  1.23
Dragengine.ConversationSystem.CConditionVariable Class Reference

Conversation condition comparing conversation value. More...

Inheritance diagram for Dragengine.ConversationSystem.CConditionVariable:
Dragengine.ConversationSystem.ConversationCondition Dragengine.LoadSave.Persistable

Classes

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

Public Member Functions

bool evaluate (ConversationPlayback playback)
 Condition is true. More...
 
Operator getOperator ()
 Operator. More...
 
int getTestValue ()
 Test value. More...
 
String getTestVariable ()
 Test variable or null to use test value. More...
 
String getVariable ()
 Name of variable. More...
 
CConditionVariable new ()
 Create conversation condition. More...
 
CConditionVariable new (PersistencyEnvironment env, FileReader reader)
 Read from file. More...
 
String persistencyFactoryName ()
 Name of PersistencyFactory required to load object from file. More...
 
void setOperator (Operator operator)
 Set operator. More...
 
void setTestValue (int value)
 Set test value. More...
 
void setTestVariable (String variable)
 Set test variable or null to use test value. More...
 
void setVariable (String variable)
 Set name of variable. More...
 
void writeObjectToFile (PersistencyEnvironment env, FileWriter writer)
 Write object to file writer. More...
 

Public Attributes

Operator pOperator
 
int pTestValue
 
String pTestVariable
 
String pVariable
 

Detailed Description

Conversation condition comparing conversation value.

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

Member Function Documentation

◆ evaluate()

bool Dragengine.ConversationSystem.CConditionVariable.evaluate ( ConversationPlayback  playback)

Condition is true.

Reimplemented from Dragengine.ConversationSystem.ConversationCondition.

◆ getOperator()

Operator Dragengine.ConversationSystem.CConditionVariable.getOperator ( )

◆ getTestValue()

int Dragengine.ConversationSystem.CConditionVariable.getTestValue ( )

Test value.

◆ getTestVariable()

String Dragengine.ConversationSystem.CConditionVariable.getTestVariable ( )

Test variable or null to use test value.

◆ getVariable()

String Dragengine.ConversationSystem.CConditionVariable.getVariable ( )

Name of variable.

◆ new() [1/2]

CConditionVariable Dragengine.ConversationSystem.CConditionVariable.new ( )

Create conversation condition.

Reimplemented from Dragengine.ConversationSystem.ConversationCondition.

◆ new() [2/2]

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

Read from file.

◆ persistencyFactoryName()

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

◆ setOperator()

void Dragengine.ConversationSystem.CConditionVariable.setOperator ( Operator  operator)

Set operator.

◆ setTestValue()

void Dragengine.ConversationSystem.CConditionVariable.setTestValue ( int  value)

Set test value.

◆ setTestVariable()

void Dragengine.ConversationSystem.CConditionVariable.setTestVariable ( String  variable)

Set test variable or null to use test value.

◆ setVariable()

void Dragengine.ConversationSystem.CConditionVariable.setVariable ( String  variable)

Set name of variable.

◆ writeObjectToFile()

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

Write object to file writer.

Implements Dragengine.LoadSave.Persistable.

Member Data Documentation

◆ pOperator

Operator Dragengine.ConversationSystem.CConditionVariable.pOperator

◆ pTestValue

int Dragengine.ConversationSystem.CConditionVariable.pTestValue

◆ pTestVariable

String Dragengine.ConversationSystem.CConditionVariable.pTestVariable

◆ pVariable

String Dragengine.ConversationSystem.CConditionVariable.pVariable

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