Drag[en]gine Script Module DragonScript Script API  1.0
CConditionActorParameter Class Reference
Inheritance diagram for CConditionActorParameter:
ConversationCondition

Classes

enum  eCompareOperators
 

Public Member Functions

bool evaluate (ConversationPlayback playback)
 
StringID getActorID ()
 
int getActorIndex ()
 
int getOperator ()
 
String getParameter ()
 
int getTestValue ()
 
CConditionActorParameter new ()
 
void setActorID (StringID id)
 
void setActorIndex (int index)
 
void setOperator (int operator)
 
void setParameter (String parameter)
 
void setTestValue (int value)
 
- Public Member Functions inherited from ConversationCondition
bool evaluate (ConversationPlayback playback)
 
ConversationCondition new ()
 

Detailed Description

Conversation condition comparing the value of an actor parameter to a given value. 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.

Author
Roland Pl├╝ss
Version
1.0

Member Function Documentation

§ evaluate()

bool evaluate ( ConversationPlayback  playback)

Determines if the condition is true.

§ getActorID()

StringID getActorID ( )

Retrieves the actor ID or null if not set.

§ getActorIndex()

int getActorIndex ( )

Retrieves the actor index or -1 if not set.

§ getOperator()

int getOperator ( )

Retrieves the operator.

§ getParameter()

String getParameter ( )

Retrieves the name of the parameter.

§ getTestValue()

int getTestValue ( )

Retrieves the test value.

§ new()

Create a new conversation condition.

§ setActorID()

void setActorID ( StringID  id)

Sets the actor ID or null if not set.

§ setActorIndex()

void setActorIndex ( int  index)

Sets the actor index or -1 if not set.

§ setOperator()

void setOperator ( int  operator)

Sets the operator.

§ setParameter()

void setParameter ( String  parameter)

Sets the name of the parameter.

§ setTestValue()

void setTestValue ( int  value)

Sets the test value.


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