Drag[en]gine Script Module DragonScript  1.23
Dragengine.StateMachineSystem.SMConditionParameterTableInt Class Reference

State machine condition evaluating an integer parameter table entry. More...

Inheritance diagram for Dragengine.StateMachineSystem.SMConditionParameterTableInt:
Dragengine.StateMachineSystem.SMCondition

Classes

enum  Operator
 Compare operator. More...
 

Public Member Functions

bool evaluateCondition (SMContext context, Dictionary parameters)
 Evaluate condition. More...
 
int getCompareValue ()
 Default compare against value. More...
 
int getDefaultValue ()
 Default value if entry to compare is not null. More...
 
ParameterTableEntry getEntry ()
 Parameter table entry to compare. More...
 
ParameterTableEntry getEntryCompareValue ()
 Parameter table entry to compare against. More...
 
Operator getOperator ()
 Compare operator from eOperators. More...
 
String getParameterNameCompareValue ()
 Use named parameter as source of compare value if not null. More...
 
SMConditionParameterTableInt negated ()
 Create condition testing the exact opposite. More...
 
SMConditionParameterTableInt new (ParameterTableEntry entry, int defaultValue, Operator operator, int compareValue)
 Create condition. More...
 
SMConditionParameterTableInt new (ParameterTableEntry entry, int defaultValue, Operator operator, int compareValue, String parameterNameCompareValue)
 Create condition. More...
 
SMConditionParameterTableInt new (ParameterTableEntry entry, int defaultValue, Operator operator, ParameterTableEntry entryCompareValue, int compareValue, String parameterNameCompareValue)
 Create condition. More...
 
void setCompareValue (int compareValue)
 Set default compare against value. More...
 
void setDefaultValue (int defaultValue)
 Set default value if entry to compare is not null. More...
 
void setEntry (ParameterTableEntry entry)
 Set parameter table entry to compare. More...
 
void setEntryCompareValue (ParameterTableEntry entry)
 Set parameter table entry to compare against. More...
 
void setOperator (Operator operator)
 Set compare operator from eOperators. More...
 
void setParameterNameCompareValue (String name)
 Use named parameter as source of compare value if not null. More...
 

Detailed Description

State machine condition evaluating an integer parameter table entry.

Compares the value of a parameter table entry against a static value or another parameter table entry.

Member Function Documentation

◆ evaluateCondition()

bool Dragengine.StateMachineSystem.SMConditionParameterTableInt.evaluateCondition ( SMContext  context,
Dictionary  parameters 
)

Evaluate condition.

Parameters
parametersDictionary with parameters of type String key and String value. Do not change the content of the dictionary as it is shared.

Implements Dragengine.StateMachineSystem.SMCondition.

◆ getCompareValue()

int Dragengine.StateMachineSystem.SMConditionParameterTableInt.getCompareValue ( )

Default compare against value.

◆ getDefaultValue()

int Dragengine.StateMachineSystem.SMConditionParameterTableInt.getDefaultValue ( )

Default value if entry to compare is not null.

◆ getEntry()

ParameterTableEntry Dragengine.StateMachineSystem.SMConditionParameterTableInt.getEntry ( )

Parameter table entry to compare.

◆ getEntryCompareValue()

ParameterTableEntry Dragengine.StateMachineSystem.SMConditionParameterTableInt.getEntryCompareValue ( )

Parameter table entry to compare against.

◆ getOperator()

Operator Dragengine.StateMachineSystem.SMConditionParameterTableInt.getOperator ( )

Compare operator from eOperators.

◆ getParameterNameCompareValue()

String Dragengine.StateMachineSystem.SMConditionParameterTableInt.getParameterNameCompareValue ( )

Use named parameter as source of compare value if not null.

◆ negated()

SMConditionParameterTableInt Dragengine.StateMachineSystem.SMConditionParameterTableInt.negated ( )

Create condition testing the exact opposite.

◆ new() [1/3]

SMConditionParameterTableInt Dragengine.StateMachineSystem.SMConditionParameterTableInt.new ( ParameterTableEntry  entry,
int  defaultValue,
Operator  operator,
int  compareValue 
)

Create condition.

◆ new() [2/3]

SMConditionParameterTableInt Dragengine.StateMachineSystem.SMConditionParameterTableInt.new ( ParameterTableEntry  entry,
int  defaultValue,
Operator  operator,
int  compareValue,
String  parameterNameCompareValue 
)

Create condition.

◆ new() [3/3]

SMConditionParameterTableInt Dragengine.StateMachineSystem.SMConditionParameterTableInt.new ( ParameterTableEntry  entry,
int  defaultValue,
Operator  operator,
ParameterTableEntry  entryCompareValue,
int  compareValue,
String  parameterNameCompareValue 
)

Create condition.

◆ setCompareValue()

void Dragengine.StateMachineSystem.SMConditionParameterTableInt.setCompareValue ( int  compareValue)

Set default compare against value.

◆ setDefaultValue()

void Dragengine.StateMachineSystem.SMConditionParameterTableInt.setDefaultValue ( int  defaultValue)

Set default value if entry to compare is not null.

◆ setEntry()

void Dragengine.StateMachineSystem.SMConditionParameterTableInt.setEntry ( ParameterTableEntry  entry)

Set parameter table entry to compare.

◆ setEntryCompareValue()

void Dragengine.StateMachineSystem.SMConditionParameterTableInt.setEntryCompareValue ( ParameterTableEntry  entry)

Set parameter table entry to compare against.

◆ setOperator()

void Dragengine.StateMachineSystem.SMConditionParameterTableInt.setOperator ( Operator  operator)

Set compare operator from eOperators.

◆ setParameterNameCompareValue()

void Dragengine.StateMachineSystem.SMConditionParameterTableInt.setParameterNameCompareValue ( String  name)

Use named parameter as source of compare value if not null.


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