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

State machine action updating parameter table entry. More...

Inheritance diagram for Dragengine.StateMachineSystem.SMActionParameterTable:
Dragengine.StateMachineSystem.SMAction

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...
 
SMActionParameterTable new (ParameterTableEntry entry, float defaultValue, Operator operator, float updateValue)
 Create action. More...
 
SMActionParameterTable new (ParameterTableEntry entry, float defaultValue, Operator operator, float updateValue, String parameterNameUpdateValue)
 Create action. More...
 
SMActionParameterTable new (ParameterTableEntry entry, float defaultValue, Operator operator, ParameterTableEntry entryUpdateValue, float updateValue, String parameterNameUpdateValue)
 Create action. More...
 
void runAction (SMContext 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...
 

Detailed Description

State machine action updating parameter table entry.

Member Function Documentation

◆ getDefaultValue()

float Dragengine.StateMachineSystem.SMActionParameterTable.getDefaultValue ( )

Default value if entry is not null.

◆ getEntry()

ParameterTableEntry Dragengine.StateMachineSystem.SMActionParameterTable.getEntry ( )

Parameter table entry to update.

◆ getEntryUpdateValue()

ParameterTableEntry Dragengine.StateMachineSystem.SMActionParameterTable.getEntryUpdateValue ( )

Parameter table entry to use as update value.

◆ getOperator()

Operator Dragengine.StateMachineSystem.SMActionParameterTable.getOperator ( )

Update operator from eOperators.

◆ getParameterNameUpdateValue()

String Dragengine.StateMachineSystem.SMActionParameterTable.getParameterNameUpdateValue ( )

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

◆ getUpdateValue()

float Dragengine.StateMachineSystem.SMActionParameterTable.getUpdateValue ( )

Default update value.

◆ new() [1/3]

SMActionParameterTable Dragengine.StateMachineSystem.SMActionParameterTable.new ( ParameterTableEntry  entry,
float  defaultValue,
Operator  operator,
float  updateValue 
)

Create action.

◆ new() [2/3]

SMActionParameterTable Dragengine.StateMachineSystem.SMActionParameterTable.new ( ParameterTableEntry  entry,
float  defaultValue,
Operator  operator,
float  updateValue,
String  parameterNameUpdateValue 
)

Create action.

◆ new() [3/3]

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

Create action.

◆ runAction()

void Dragengine.StateMachineSystem.SMActionParameterTable.runAction ( SMContext  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.StateMachineSystem.SMAction.

◆ setDefaultValue()

void Dragengine.StateMachineSystem.SMActionParameterTable.setDefaultValue ( float  defaultValue)

Set default value if entry is not null.

◆ setEntry()

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

Set parameter table entry to update.

◆ setEntryUpdateValue()

void Dragengine.StateMachineSystem.SMActionParameterTable.setEntryUpdateValue ( ParameterTableEntry  entry)

Set parameter table entry to use as update value.

◆ setOperator()

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

Set update operator from eOperators.

◆ setParameterNameUpdateValue()

void Dragengine.StateMachineSystem.SMActionParameterTable.setParameterNameUpdateValue ( String  name)

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

◆ setUpdateValue()

void Dragengine.StateMachineSystem.SMActionParameterTable.setUpdateValue ( float  updateValue)

Set default update value.


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