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

State machine condition evaluating a boolean parameter table entry. More...

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

Public Member Functions

bool evaluateCondition (SMContext context, Dictionary parameters)
 Evaluate condition. More...
 
bool getCompareValue ()
 Default compare against value. More...
 
bool 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...
 
bool getEqual ()
 Evaluates to true if values are equal. More...
 
String getParameterNameCompareValue ()
 Use named parameter as source of compare value if not null. More...
 
SMConditionParameterTableBool negated ()
 Create condition testing the exact opposite. More...
 
SMConditionParameterTableBool new (ParameterTableEntry entry, bool defaultValue, bool equal, bool compareValue)
 Create condition. More...
 
SMConditionParameterTableBool new (ParameterTableEntry entry, bool defaultValue, bool equal, bool compareValue, String parameterNameCompareValue)
 Create condition. More...
 
SMConditionParameterTableBool new (ParameterTableEntry entry, bool defaultValue, bool equal, ParameterTableEntry entryCompareValue, bool compareValue, String parameterNameCompareValue)
 Create condition. More...
 
void setCompareValue (bool compareValue)
 Set default compare against value. More...
 
void setDefaultValue (bool 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 setEqual (bool equal)
 Set evaluates to true if values are equal. More...
 
void setParameterNameCompareValue (String name)
 Use named parameter as source of compare value if not null. More...
 

Detailed Description

State machine condition evaluating a boolean parameter table entry.

Member Function Documentation

◆ evaluateCondition()

bool Dragengine.StateMachineSystem.SMConditionParameterTableBool.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()

bool Dragengine.StateMachineSystem.SMConditionParameterTableBool.getCompareValue ( )

Default compare against value.

◆ getDefaultValue()

bool Dragengine.StateMachineSystem.SMConditionParameterTableBool.getDefaultValue ( )

Default value if entry to compare is not null.

◆ getEntry()

ParameterTableEntry Dragengine.StateMachineSystem.SMConditionParameterTableBool.getEntry ( )

Parameter table entry to compare.

◆ getEntryCompareValue()

ParameterTableEntry Dragengine.StateMachineSystem.SMConditionParameterTableBool.getEntryCompareValue ( )

Parameter table entry to compare against.

◆ getEqual()

bool Dragengine.StateMachineSystem.SMConditionParameterTableBool.getEqual ( )

Evaluates to true if values are equal.

◆ getParameterNameCompareValue()

String Dragengine.StateMachineSystem.SMConditionParameterTableBool.getParameterNameCompareValue ( )

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

◆ negated()

SMConditionParameterTableBool Dragengine.StateMachineSystem.SMConditionParameterTableBool.negated ( )

Create condition testing the exact opposite.

◆ new() [1/3]

SMConditionParameterTableBool Dragengine.StateMachineSystem.SMConditionParameterTableBool.new ( ParameterTableEntry  entry,
bool  defaultValue,
bool  equal,
bool  compareValue 
)

Create condition.

◆ new() [2/3]

SMConditionParameterTableBool Dragengine.StateMachineSystem.SMConditionParameterTableBool.new ( ParameterTableEntry  entry,
bool  defaultValue,
bool  equal,
bool  compareValue,
String  parameterNameCompareValue 
)

Create condition.

◆ new() [3/3]

SMConditionParameterTableBool Dragengine.StateMachineSystem.SMConditionParameterTableBool.new ( ParameterTableEntry  entry,
bool  defaultValue,
bool  equal,
ParameterTableEntry  entryCompareValue,
bool  compareValue,
String  parameterNameCompareValue 
)

Create condition.

◆ setCompareValue()

void Dragengine.StateMachineSystem.SMConditionParameterTableBool.setCompareValue ( bool  compareValue)

Set default compare against value.

◆ setDefaultValue()

void Dragengine.StateMachineSystem.SMConditionParameterTableBool.setDefaultValue ( bool  defaultValue)

Set default value if entry to compare is not null.

◆ setEntry()

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

Set parameter table entry to compare.

◆ setEntryCompareValue()

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

Set parameter table entry to compare against.

◆ setEqual()

void Dragengine.StateMachineSystem.SMConditionParameterTableBool.setEqual ( bool  equal)

Set evaluates to true if values are equal.

◆ setParameterNameCompareValue()

void Dragengine.StateMachineSystem.SMConditionParameterTableBool.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: