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

Behavior tree action updating parameter table entry. More...

Inheritance diagram for Dragengine.BehaviorTreeSystem.BTActionParameterTable:
Dragengine.BehaviorTreeSystem.BTAction

Classes

enum  Operator
 Update operator. More...
 

Public Member Functions

float getDefaultValue ()
 Default value if entry is not null. More...
 
ParameterTableEntry getEntry ()
 Parameter table entry to update. More...
 
ParameterTableEntry getEntryUpdateValue ()
 Parameter table entry to use as update value. More...
 
Operator getOperator ()
 Update operator from eOperators. More...
 
String getParameterNameUpdateValue ()
 Use named parameter as source of update value if not null. More...
 
float getUpdateValue ()
 Default update value. More...
 
BTActionParameterTable new (ParameterTableEntry entry, float defaultValue, Operator operator, float updateValue)
 Create action. More...
 
BTActionParameterTable new (ParameterTableEntry entry, float defaultValue, Operator operator, float updateValue, String parameterNameUpdateValue)
 Create action. More...
 
BTActionParameterTable new (ParameterTableEntry entry, float defaultValue, Operator operator, ParameterTableEntry entryUpdateValue, float updateValue, String parameterNameUpdateValue)
 Create action. More...
 
BTResult runAction (BTContext context, Dictionary parameters)
 Run action. More...
 
void setDefaultValue (float defaultValue)
 Set default value if entry is not null. More...
 
void setEntry (ParameterTableEntry entry)
 Set parameter table entry to update. More...
 
void setEntryUpdateValue (ParameterTableEntry entry)
 Set parameter table entry to use as update value. More...
 
void setOperator (Operator operator)
 Set update operator from eOperators. More...
 
void setParameterNameUpdateValue (String name)
 Use named parameter as source of update value if not null. More...
 
void setUpdateValue (float updateValue)
 Set default update value. More...
 

Public Attributes

float pDefaultValue
 
ParameterTableEntry pEntry
 
ParameterTableEntry pEntryUpdateValue
 
Operator pOperator
 
String pParameterNameUpdateValue
 
float pUpdateValue
 

Detailed Description

Behavior tree action updating parameter table entry.

This action always returns BTResult.success.

Member Function Documentation

◆ getDefaultValue()

float Dragengine.BehaviorTreeSystem.BTActionParameterTable.getDefaultValue ( )

Default value if entry is not null.

◆ getEntry()

ParameterTableEntry Dragengine.BehaviorTreeSystem.BTActionParameterTable.getEntry ( )

Parameter table entry to update.

◆ getEntryUpdateValue()

ParameterTableEntry Dragengine.BehaviorTreeSystem.BTActionParameterTable.getEntryUpdateValue ( )

Parameter table entry to use as update value.

◆ getOperator()

Operator Dragengine.BehaviorTreeSystem.BTActionParameterTable.getOperator ( )

Update operator from eOperators.

◆ getParameterNameUpdateValue()

String Dragengine.BehaviorTreeSystem.BTActionParameterTable.getParameterNameUpdateValue ( )

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

◆ getUpdateValue()

float Dragengine.BehaviorTreeSystem.BTActionParameterTable.getUpdateValue ( )

Default update value.

◆ new() [1/3]

BTActionParameterTable Dragengine.BehaviorTreeSystem.BTActionParameterTable.new ( ParameterTableEntry  entry,
float  defaultValue,
Operator  operator,
float  updateValue 
)

Create action.

◆ new() [2/3]

BTActionParameterTable Dragengine.BehaviorTreeSystem.BTActionParameterTable.new ( ParameterTableEntry  entry,
float  defaultValue,
Operator  operator,
float  updateValue,
String  parameterNameUpdateValue 
)

Create action.

◆ new() [3/3]

BTActionParameterTable Dragengine.BehaviorTreeSystem.BTActionParameterTable.new ( ParameterTableEntry  entry,
float  defaultValue,
Operator  operator,
ParameterTableEntry  entryUpdateValue,
float  updateValue,
String  parameterNameUpdateValue 
)

Create action.

◆ runAction()

BTResult Dragengine.BehaviorTreeSystem.BTActionParameterTable.runAction ( BTContext  context,
Dictionary  parameters 
)

Run action.

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.BTAction.

◆ setDefaultValue()

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

Set default value if entry is not null.

◆ setEntry()

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

Set parameter table entry to update.

◆ setEntryUpdateValue()

void Dragengine.BehaviorTreeSystem.BTActionParameterTable.setEntryUpdateValue ( ParameterTableEntry  entry)

Set parameter table entry to use as update value.

◆ setOperator()

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

Set update operator from eOperators.

◆ setParameterNameUpdateValue()

void Dragengine.BehaviorTreeSystem.BTActionParameterTable.setParameterNameUpdateValue ( String  name)

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

◆ setUpdateValue()

void Dragengine.BehaviorTreeSystem.BTActionParameterTable.setUpdateValue ( float  updateValue)

Set default update value.

Member Data Documentation

◆ pDefaultValue

float Dragengine.BehaviorTreeSystem.BTActionParameterTable.pDefaultValue

◆ pEntry

ParameterTableEntry Dragengine.BehaviorTreeSystem.BTActionParameterTable.pEntry

◆ pEntryUpdateValue

ParameterTableEntry Dragengine.BehaviorTreeSystem.BTActionParameterTable.pEntryUpdateValue

◆ pOperator

Operator Dragengine.BehaviorTreeSystem.BTActionParameterTable.pOperator

◆ pParameterNameUpdateValue

String Dragengine.BehaviorTreeSystem.BTActionParameterTable.pParameterNameUpdateValue

◆ pUpdateValue

float Dragengine.BehaviorTreeSystem.BTActionParameterTable.pUpdateValue

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