Drag[en]gine Script Module DragonScript  1.21
Dragengine.StateMachineSystem.SMConditionTrigger Class Reference

State machine condition evaluating a boolean parameter table entry. More...

Inheritance diagram for Dragengine.StateMachineSystem.SMConditionTrigger:
Dragengine.StateMachineSystem.SMCondition

Classes

enum  TestMode
 Test mode. More...
 

Public Member Functions

bool evaluateCondition (SMContext context, Dictionary parameters)
 Evaluate condition. More...
 
StringID getName ()
 Name of the trigger to evaluate. More...
 
TestMode getTestMode ()
 TestMode. More...
 
TSTriggerTable getTriggerTable ()
 Trigger table. More...
 
TSTriggerTarget getTriggerTarget ()
 Cached trigger target. More...
 
SMConditionTrigger negated ()
 Create condition testing the exact opposite. More...
 
SMConditionTrigger new (StringID name, TestMode testMode)
 Create condition. More...
 
SMConditionTrigger new (TSTriggerTable triggerTable, StringID name, TestMode testMode)
 Create condition. More...
 
void setName (StringID name)
 Set name of the trigger to evaluate. More...
 
void setTestMode (TestMode testMode)
 Set action. More...
 

Protected Member Functions

void setTriggerTable (TSTriggerTable triggerTable)
 Set trigger table. More...
 

Detailed Description

State machine condition evaluating a boolean parameter table entry.

Member Function Documentation

◆ evaluateCondition()

bool Dragengine.StateMachineSystem.SMConditionTrigger.evaluateCondition ( SMContext  context,
Dictionary  parameters 
)

Evaluate condition.

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

◆ getName()

StringID Dragengine.StateMachineSystem.SMConditionTrigger.getName ( )

Name of the trigger to evaluate.

◆ getTestMode()

TestMode Dragengine.StateMachineSystem.SMConditionTrigger.getTestMode ( )

◆ getTriggerTable()

TSTriggerTable Dragengine.StateMachineSystem.SMConditionTrigger.getTriggerTable ( )

Trigger table.

◆ getTriggerTarget()

TSTriggerTarget Dragengine.StateMachineSystem.SMConditionTrigger.getTriggerTarget ( )

Cached trigger target.

◆ negated()

SMConditionTrigger Dragengine.StateMachineSystem.SMConditionTrigger.negated ( )

Create condition testing the exact opposite.

◆ new() [1/2]

SMConditionTrigger Dragengine.StateMachineSystem.SMConditionTrigger.new ( StringID  name,
TestMode  testMode 
)

Create condition.

◆ new() [2/2]

SMConditionTrigger Dragengine.StateMachineSystem.SMConditionTrigger.new ( TSTriggerTable  triggerTable,
StringID  name,
TestMode  testMode 
)

Create condition.

◆ setName()

void Dragengine.StateMachineSystem.SMConditionTrigger.setName ( StringID  name)

Set name of the trigger to evaluate.

◆ setTestMode()

void Dragengine.StateMachineSystem.SMConditionTrigger.setTestMode ( TestMode  testMode)

Set action.

◆ setTriggerTable()

void Dragengine.StateMachineSystem.SMConditionTrigger.setTriggerTable ( TSTriggerTable  triggerTable)
protected

Set trigger table.


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