Drag[en]gine Script Module DragonScript 1.32.1
Loading...
Searching...
No Matches
Dragengine.StateMachineSystem.SMTransition Class Reference

State machine transition. More...

Inheritance diagram for Dragengine.StateMachineSystem.SMTransition:

Classes

enum  ConditionMode
 Condition modes. More...
 

Public Member Functions

void addAction (SMStateAction action)
 Add action.
 
void addCondition (String condition)
 Add condition.
 
bool evaluateConditions (SMContext context)
 Evaluate all conditions.
 
SMStateAction findAction (Block ablock)
 Find action with block with parameter SMStateAction.
 
String findCondition (Block ablock)
 Find condition with block with parameter String.
 
void forEachAction (Block ablock)
 Visit actions with block with parameter SMStateAction.
 
void forEachCondition (Block ablock)
 Visit conditions with block with parameter String.
 
SMStateAction getActionAt (int index)
 Get action at index.
 
int getActionCount ()
 Count of actions.
 
String getConditionAt (int index)
 Get condition at index.
 
int getConditionCount ()
 Count of conditions.
 
ConditionMode getConditionMode ()
 Condition mode from eConditionModes.
 
String getStateID ()
 Identifier of state to switch to or null to stay in the same state.
 
SMTransition new (SMTransition transition)
 Create copy of state machine transition.
 
SMTransition new (String event)
 Create state machine transition staying in the same state.
 
SMTransition new (String event, String stateID)
 Create state machine transition.
 
void setConditionMode (ConditionMode mode)
 Set condition mode from eConditionModes.
 

Public Attributes

Array pActions
 
ConditionMode pConditionMode
 
String pEvent
 
Dictionary pParameters
 

Detailed Description

State machine transition.

Transitions run a set of actions before activating the new state in the state machine.

Member Function Documentation

◆ addAction()

void Dragengine.StateMachineSystem.SMTransition.addAction ( SMStateAction  action)

Add action.

◆ addCondition()

void Dragengine.StateMachineSystem.SMTransition.addCondition ( String  condition)

Add condition.

◆ evaluateConditions()

bool Dragengine.StateMachineSystem.SMTransition.evaluateConditions ( SMContext  context)

Evaluate all conditions.

If no condition is present true is returned.

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

◆ findAction()

SMStateAction Dragengine.StateMachineSystem.SMTransition.findAction ( Block  ablock)

Find action with block with parameter SMStateAction.

◆ findCondition()

String Dragengine.StateMachineSystem.SMTransition.findCondition ( Block  ablock)

Find condition with block with parameter String.

◆ forEachAction()

void Dragengine.StateMachineSystem.SMTransition.forEachAction ( Block  ablock)

Visit actions with block with parameter SMStateAction.

◆ forEachCondition()

void Dragengine.StateMachineSystem.SMTransition.forEachCondition ( Block  ablock)

Visit conditions with block with parameter String.

◆ getActionAt()

SMStateAction Dragengine.StateMachineSystem.SMTransition.getActionAt ( int  index)

Get action at index.

◆ getActionCount()

int Dragengine.StateMachineSystem.SMTransition.getActionCount ( )

Count of actions.

◆ getConditionAt()

String Dragengine.StateMachineSystem.SMTransition.getConditionAt ( int  index)

Get condition at index.

◆ getConditionCount()

int Dragengine.StateMachineSystem.SMTransition.getConditionCount ( )

Count of conditions.

◆ getConditionMode()

ConditionMode Dragengine.StateMachineSystem.SMTransition.getConditionMode ( )

Condition mode from eConditionModes.

◆ getStateID()

String Dragengine.StateMachineSystem.SMTransition.getStateID ( )

Identifier of state to switch to or null to stay in the same state.

◆ new() [1/3]

SMTransition Dragengine.StateMachineSystem.SMTransition.new ( SMTransition  transition)

Create copy of state machine transition.

Version
1.26

◆ new() [2/3]

SMTransition Dragengine.StateMachineSystem.SMTransition.new ( String  event)

Create state machine transition staying in the same state.

Parameters
eventEvent to react to.

◆ new() [3/3]

SMTransition Dragengine.StateMachineSystem.SMTransition.new ( String  event,
String  stateID 
)

Create state machine transition.

Parameters
eventEvent to react to.
stateIDState to switch to or null to stay in the same state.

◆ setConditionMode()

void Dragengine.StateMachineSystem.SMTransition.setConditionMode ( ConditionMode  mode)

Set condition mode from eConditionModes.

Member Data Documentation

◆ pActions

Array Dragengine.StateMachineSystem.SMTransition.pActions

◆ pConditionMode

ConditionMode Dragengine.StateMachineSystem.SMTransition.pConditionMode

◆ pEvent

String Dragengine.StateMachineSystem.SMTransition.pEvent

◆ pParameters

Dictionary Dragengine.StateMachineSystem.SMTransition.pParameters

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