Dragengine.StateMachineSystem.SMActionParameterTable Class Reference

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

Inheritance diagram for Dragengine.StateMachineSystem.SMActionParameterTable:

Classes
enum	Operator
	Update operator. More...

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

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

parameters

Dictionary 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:

• SMActionParameterTable.ds