Drag[en]gine Script Module DragonScript  1.23
Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat Class Reference

Behavior tree condition evaluating a floating point parameter table entry. More...

Inheritance diagram for Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat:
Dragengine.BehaviorTreeSystem.BTCondition

Classes

enum  Operator
 Compare operator. More...
 

Public Member Functions

bool evaluateCondition (BTContext context, Dictionary parameters)
 Evaluate condition. More...
 
float getCompareValue ()
 Default compare against value. More...
 
float 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...
 
float getThreshold ()
 Threshold value. More...
 
BTConditionParameterTableFloat negated ()
 Create condition testing the exact opposite. More...
 
BTConditionParameterTableFloat new (ParameterTableEntry entry, float defaultValue, Operator operator, float compareValue)
 Create condition. More...
 
BTConditionParameterTableFloat new (ParameterTableEntry entry, float defaultValue, Operator operator, float compareValue, String parameterNameCompareValue)
 Create condition. More...
 
BTConditionParameterTableFloat new (ParameterTableEntry entry, float defaultValue, Operator operator, ParameterTableEntry entryCompareValue, float compareValue, String parameterNameCompareValue)
 Create condition. More...
 
void setCompareValue (float compareValue)
 Set default compare against value. More...
 
void setDefaultValue (float 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...
 
void setThreshold (float threshold)
 Set threshold value. More...
 

Public Attributes

float pCompareValue
 
float pDefaultValue
 
ParameterTableEntry pEntry
 
ParameterTableEntry pEntryCompareValue
 
Operator pOperator
 
String pParameterNameCompareValue
 
float pThreshold
 

Detailed Description

Behavior tree condition evaluating a floating point parameter table entry.

Compares the value of a parameter table entry against a static value or another parameter table entry. A threshold is used for the compare operations defaulting to 0.0001.

Member Function Documentation

◆ evaluateCondition()

bool Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat.evaluateCondition ( BTContext  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.BehaviorTreeSystem.BTCondition.

◆ getCompareValue()

float Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat.getCompareValue ( )

Default compare against value.

◆ getDefaultValue()

float Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat.getDefaultValue ( )

Default value if entry to compare is not null.

◆ getEntry()

ParameterTableEntry Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat.getEntry ( )

Parameter table entry to compare.

◆ getEntryCompareValue()

ParameterTableEntry Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat.getEntryCompareValue ( )

Parameter table entry to compare against.

◆ getOperator()

Operator Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat.getOperator ( )

Compare operator from eOperators.

◆ getParameterNameCompareValue()

String Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat.getParameterNameCompareValue ( )

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

◆ getThreshold()

float Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat.getThreshold ( )

Threshold value.

◆ negated()

BTConditionParameterTableFloat Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat.negated ( )

Create condition testing the exact opposite.

◆ new() [1/3]

BTConditionParameterTableFloat Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat.new ( ParameterTableEntry  entry,
float  defaultValue,
Operator  operator,
float  compareValue 
)

Create condition.

◆ new() [2/3]

BTConditionParameterTableFloat Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat.new ( ParameterTableEntry  entry,
float  defaultValue,
Operator  operator,
float  compareValue,
String  parameterNameCompareValue 
)

Create condition.

◆ new() [3/3]

BTConditionParameterTableFloat Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat.new ( ParameterTableEntry  entry,
float  defaultValue,
Operator  operator,
ParameterTableEntry  entryCompareValue,
float  compareValue,
String  parameterNameCompareValue 
)

Create condition.

◆ setCompareValue()

void Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat.setCompareValue ( float  compareValue)

Set default compare against value.

◆ setDefaultValue()

void Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat.setDefaultValue ( float  defaultValue)

Set default value if entry to compare is not null.

◆ setEntry()

void Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat.setEntry ( ParameterTableEntry  entry)

Set parameter table entry to compare.

◆ setEntryCompareValue()

void Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat.setEntryCompareValue ( ParameterTableEntry  entry)

Set parameter table entry to compare against.

◆ setOperator()

void Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat.setOperator ( Operator  operator)

Set compare operator from eOperators.

◆ setParameterNameCompareValue()

void Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat.setParameterNameCompareValue ( String  name)

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

◆ setThreshold()

void Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat.setThreshold ( float  threshold)

Set threshold value.

Member Data Documentation

◆ pCompareValue

float Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat.pCompareValue

◆ pDefaultValue

float Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat.pDefaultValue

◆ pEntry

ParameterTableEntry Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat.pEntry

◆ pEntryCompareValue

ParameterTableEntry Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat.pEntryCompareValue

◆ pOperator

Operator Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat.pOperator

◆ pParameterNameCompareValue

String Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat.pParameterNameCompareValue

◆ pThreshold

float Dragengine.BehaviorTreeSystem.BTConditionParameterTableFloat.pThreshold

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