Drag[en]gine Script Module DragonScript Script API  1.0
CConditionActorParameter Class Reference

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

Inheritance diagram for CConditionActorParameter:
ConversationCondition Persistable

Classes

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

Public Member Functions

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

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 evaluate ( ConversationPlayback  playback)

Condition is true.

◆ getActorID()

StringID getActorID ( )

Actor ID or null if not set.

◆ getActorIndex()

int getActorIndex ( )

Actor index or -1 if not set.

◆ getOperator()

int getOperator ( )

Operator.

◆ getParameter()

String getParameter ( )

Name of the parameter.

◆ getTestValue()

int getTestValue ( )

Test value.

◆ new() [1/2]

Create conversation condition.

◆ new() [2/2]

Read from file.

◆ persistencyFactoryName()

String 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 Persistable.

◆ setActorID()

void setActorID ( StringID  id)

Set actor ID or null if not set.

◆ setActorIndex()

void setActorIndex ( int  index)

Set actor index or -1 if not set.

◆ setOperator()

void setOperator ( int  operator)

Set operator.

◆ setParameter()

void setParameter ( String  parameter)

Set name of the parameter.

◆ setTestValue()

void setTestValue ( int  value)

Set test value.

◆ writeObjectToFile()

void writeObjectToFile ( PersistencyEnvironment  env,
FileWriter  writer 
)

Write object to file writer.

Implements Persistable.


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