Dragengine.StateMachineSystem.SMStateAction Class Reference

Action to run in a state machine state. More...

Inheritance diagram for Dragengine.StateMachineSystem.SMStateAction:

Public Member Functions
void	addCondition (String condition)
	Add condition.
bool	evaluateConditions (SMContext context)
	Evaluate all conditions.
String	findCondition (Block ablock)
	Find condition with block with parameter String.
void	forEachCondition (Block ablock)
	Visit conditions with block with parameter String.
String	getActionID ()
	Action identifier or null.
String	getConditionAt (int index)
	Get condition at index.
int	getConditionCount ()
	Count of conditions.
SMTransition.ConditionMode	getConditionMode ()
	Condition mode from eConditionModes.
Dictionary	getParameters ()
	Parameters as Dictionary of type String key and String value.
String	getStateID ()
	State to transition to after action finished or null.
SMStateAction	new (SMStateAction action)
	Create copy of state machine action.
SMStateAction	new (String actionID)
	Create state machine action.
void	setConditionMode (SMTransition.ConditionMode mode)
	Set condition mode from eConditionModes.
void	setStateID (String id)
	Set state to transition to after action finished or null.

Public Attributes
String	pActionID
SMTransition.ConditionMode	pConditionMode
Array	pConditions
Dictionary	pParameters

Detailed Description

Action to run in a state machine state.

SMAction subclasses are created by the game developer and added to the state machine. If state action is run the action is looked up and run.

Member Function Documentation

addCondition()

void Dragengine.StateMachineSystem.SMStateAction.addCondition

(

String

condition

)

Add condition.

Version

1.26

evaluateConditions()

bool Dragengine.StateMachineSystem.SMStateAction.evaluateConditions

(

SMContext

context

)

Evaluate all conditions.

Version

1.25

If no condition is present true is returned.

Parameters

parameters

Dictionary with parameters of type String key and String value. Do not change the content of the dictionary as it is shared.

findCondition()

String Dragengine.StateMachineSystem.SMStateAction.findCondition

(

Block

ablock

)

Find condition with block with parameter String.

Version

1.26

forEachCondition()

void Dragengine.StateMachineSystem.SMStateAction.forEachCondition

(

Block

ablock

)

Visit conditions with block with parameter String.

Version

1.26

getActionID()

String Dragengine.StateMachineSystem.SMStateAction.getActionID

(

)

Action identifier or null.

getConditionAt()

String Dragengine.StateMachineSystem.SMStateAction.getConditionAt

(

int

index

)

Get condition at index.

Version

1.26

getConditionCount()

int Dragengine.StateMachineSystem.SMStateAction.getConditionCount

(

)

Count of conditions.

Version

1.26

getConditionMode()

SMTransition.ConditionMode Dragengine.StateMachineSystem.SMStateAction.getConditionMode

(

)

Condition mode from eConditionModes.

Version

1.26

getParameters()

Dictionary Dragengine.StateMachineSystem.SMStateAction.getParameters

(

)

Parameters as Dictionary of type String key and String value.

Warning

Do not change the content of the dictionary as it is shared.

getStateID()

String Dragengine.StateMachineSystem.SMStateAction.getStateID

(

)

State to transition to after action finished or null.

Version

1.26

new() [1/2]

SMStateAction Dragengine.StateMachineSystem.SMStateAction.new

(

SMStateAction

action

)

Create copy of state machine action.

Version

1.26

new() [2/2]

SMStateAction Dragengine.StateMachineSystem.SMStateAction.new

(

String

actionID

)

Create state machine action.

setConditionMode()

void Dragengine.StateMachineSystem.SMStateAction.setConditionMode

(

SMTransition.ConditionMode

mode

)

Set condition mode from eConditionModes.

Version

1.26

setStateID()

void Dragengine.StateMachineSystem.SMStateAction.setStateID

(

String

id

)

Set state to transition to after action finished or null.

Version

1.26

Member Data Documentation

pActionID

String Dragengine.StateMachineSystem.SMStateAction.pActionID

pConditionMode

SMTransition.ConditionMode Dragengine.StateMachineSystem.SMStateAction.pConditionMode

pConditions

Array Dragengine.StateMachineSystem.SMStateAction.pConditions

pParameters

Dictionary Dragengine.StateMachineSystem.SMStateAction.pParameters

---

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

• SMStateAction.ds