Behavior element behavior adding StateMachine support.

Loads state machine from file (*.desm) and creates a SMContext. Other behaviors can add actions and conditions to this state machine allowing to compose state machine actions and conditions easily.

You can assign actions and conditions without using other behaviors by using one or more factories. The factories are added to the behavior. Upon creating the behavior instances the factories are asked to create and assign SMAction and SMCondition.

This behavior can be used in different ways depending on the needs.

Single State Machine Usage

This is the most simple solution where only one state machine is used. For many situations this is enough and is the most simple solution to use. Add one ECBehaviorStateMachine with no ID to the element and as many other behaviors adding actions and conditions as required. Set the stateMachine.path property to define the state machine to load. Then use behavior listeners to run events on the state machine at the appropriate time.

See Element Class Example for example code.

Multiple State Machine Usage

You can add multiple instances of ECBehaviorStateMachine to the element to load and use multiple state machines. This can be for using multiple state machines together to model complex logic. In this situation behaviors assigining actions and conditions do add them to all instances of ECBehaviorStateMachine. This is usually not a problem since the state machines are written to use only the actions and conditions making sense to be used.

See Element Class Example for example code.

This behavior can be used multiple times on an element to add multiple custom colors to mainpulate. Use the behavior identifier to tell them apart.

Element class properties have the prefix stateMachine. or stateMachine({id}). if id is not empty.

Set path to state machine file to load.

• Full name: stateMachine.path or stateMachine({id}).path
• Type: string
• Default Value: empty string
• Expected File Type: *.desm
• Example (*.deeclass)

  <string name='stateMachine.path'>actor.desm</string>

Debug mode prefix. If not empty string enables debug mode with prefix to locate log messages easily.

• Full name: stateMachine.debug or stateMachine({id}).debug
• Type: string
• Default Value: empty string
• Example (*.deeclass)

  <string name='stateMachine.debug'>Debug-Actor-SM</string>

This behavior has no events.

This behavior adds these state machine actions.

Set owner element parameters.

This is an example of using this action to fully hide the owner element:

<action name='element.set'>
  <parameter name='visible'>false</parameter>
  <parameter name='touchable'>false</parameter>
</action>

Update owner element.

This is an example of using this action to dispose element:

<action name='element.set'>
  <parameter name='dispose'/>
</action>

This is an example of using this action to teleport the element to a spawn point:

<action name='element.set'>
  <parameter name='teleport'>spawn</parameter>
  <parameter name='teleport.target'>portal1.exit</parameter>
</action>

Update behavior element resolved from state machine event parameter. If event parameter is null action has no effect. Supported are event parameters castable to these types:

• BehaviorElement
• CollisionInfo. Requires collider with owner set to BehaviorElement instance.

This is an example of using this action:

<action name='eventElement.update'>
  <parameter name='runEvent'>do something</parameter>
</action>

Runs action from game world behavior GWBehaviorBTSM. Game world behaviors can add state machine actions to GWBehaviorBTSM similar to how element class behaviors can add state machine actions to this behavior. This allows state machines to access actions specific to a game world. The action is run as if it has been added to this behavior. All parameters defined in the action are passed to the game world action with the addition of the parameter element set to the behavior element owning the state machine. If the element owning this behavior is not in a game world or the action can not be found, nothing is done.

This is an example of using this action to spawn a new element:

<action name='gameWorld'>
  <parameter name='action'>spawn</parameter>
  <parameter name='class'>MyGameObjectClass</parameter>
  <parameter name='properties'>propertyName1:propertyValue1 propertyName2:propertyValue2</parameter>
  <parameter name='spawnPoint'>spawn point name</parameter>
</action>

This is an example of using this action to run event on application state machines:

<action name='gameWorld'>
  <parameter name='action'>app.btsm.runEvent</parameter>
  <parameter name='event'>fade over black</parameter>
</action>

This behavior adds these state machine conditions.

Evaluate owner element parameters.

This is an example of using this condition to check if the element is visible, touchable, in a game world and not parented to another element:

<action name='myAction'>
  <condition>element.check</condition>
  <parameter name='element.visible'>true</parameter>
  <parameter name='element.touchable'>true</parameter>
  <parameter name='element.inGameWorld'>true</parameter>
  <parameter name='element.hasParent'>false</parameter>
</action>

Check one or more parameters of behavior element stored in state machine event parameter. If event parameter is null condition fails. Supported are event parameters castable to these types:

• BehaviorElement
• CollisionInfo. Requires collider with owner set to BehaviorElement instance.

This is an example of using this action:

<action name='myAction'>
  <condition>eventElement.check</condition>
  <parameter name='eventElement.flags.set'>can pick up</parameter>
</action>

Evaluate condition from game world behavior GWBehaviorBTSM. Game world behaviors can add state machine conditions to GWBehaviorBTSM similar to how element class behaviors can add state machine conditions to this behavior. This allows state machines to access conditions specific to a game world. The condition is evaluated as if it has been added to this behavior. All parameters defined in the condition are passed to the game world condition with the addition of the parameter gameWorld.element set to the behavior element owning the state machine. If the element owning this behavior is not in a game world or the condition can not be found, false is returned.

This is an example of using this condition to evaluate a game state:

<action name='myAction'>
  <condition>gameWorld</condition>
  <parameter name='gameWorld.condition'>winningCondition.check</parameter>
  <parameter name='gameWorld.condition.foundCounts'>10</parameter>
</action>

This behavior sends these state machine events.

State machine context has been created and the initial state has been set.

Element has been added to game world. gameWorld action/condition is now valid to be used.

Element has been removed from game world. gameWorld action/condition are no more valid to be used.

First frame update after element has been added to game world.

Send by BAAStateMachine or BAAVRHandStateMachine if action has been activated.

Send by BAAStateMachine or BAAVRHandStateMachine if action has been activated while loading a game state.

Send by BAAStateMachine or BAAVRHandStateMachine if element has been added to game world while action is active. Same as addToGameWorld but send only if BAAStateMachine is used.

Send by BAAStateMachine or BAAVRHandStateMachine if element has been removed from game world while action is active. Same as removeFromGameWorld but send only if BAAStateMachine is used.

Send by BAAStateMachine or BAAVRHandStateMachine if player takes control of element.

Send by BAAStateMachine or BAAVRHandStateMachine if player releases control of element.

Send by BAAStateMachine or BAAVRHandStateMachine on element think.

Send by BAAStateMachine or BAAVRHandStateMachine on element think if player controls element.

Send by BAAStateMachine or BAAVRHandStateMachine on element post think.

Send by BAAStateMachine or BAAVRHandStateMachine on element post think if player controls element.

Send by BAAStateMachine or BAAVRHandStateMachine if action has been cancelled.

Send by BAAStateMachine or BAAVRHandStateMachine if ECBehaviorColliderAI hit something. Use eventParameter.update or eventParameter.check to work with the hit element.

This behavior adds these behavior tree actions if behavior tree is present. If behavior has non-empty identifier replace stateMachine with stateMachine(id).

Set state machine parameters.

This is an example of using this action to switch state machine to state jump to state:

<action name='stateMachine.set'>
  <parameter name='state'>jump to state</parameter>
</action>

Run event on state machine.

This is an example of using this action to run event do something on the current state machine state:

<action name='stateMachine.event'>
  <parameter name='id'>do something</parameter>
</action>

Check one or more state machine parameters. Action succeeds if all parameter value matches their respective state machine parameter otherwise action fails. This action is typically used as first action in a sequence to run the sequence only if a state machine parameter matches (or not).

This is an example of using this action to run a sequence only if state is ready state:

<sequence>
  <action name='stateMachine.check'>
    <parameter name='state'>ready state</parameter>
  </action>
  <!-- actions here run only if state machine is in the expected state. -->
</sequence>

This behavior adds these behavior tree conditions if behavior tree is present. If behavior has non-empty identifier replace stateMachine with stateMachine(id).

Check one or more state machine parameters. Conditions returns true if all parameter value match their respective state machine parameter. This condition is typically used to run an action or sequence of actions as long as state machine conditions are true.

This is an example of using this condition to run an action only if state is ready state:

<action name='myAction' id='doing something'>
  <condition>stateMachine.check</condition>
  <parameter name='stateMachine.state'>ready state</parameter>
</action>

This behavior requires no other behaviors.

• ECBehaviorBehaviorTree: Add actions and conditions for behavior trees to use.

This behavior does support element class to be persistable (setPersistable). Saves state machine content (SMContext).

ECBehaviorStateMachine.

Since DragonScript Module Version 1.3

• Create element logic without writing state machine using scripts.
• Reuse element logic across different elements.
• Split element logic into smaller logic units using multiple state machines (potentially reused).

Example of the Single State Machine Usage.

class MyElementClass extends BehaviorElementClass
  func new()
    var ECBehaviorStateMachine smbehavior = ECBehaviorStateMachine.new(this)
    smbehavior.getPath().setValue("/content/myBehavior.desm")
    
    // here you can add now behaviors assigining actions and conditions for
    // the state machine to use
    ...
    
    // add listeners to behaviors to send events to the state machine
    var ECBehaviorTwoStateAnimated animated = ...
    animated.addActionConditionFactory(MyEventListener.Factory.new(smbehavior))
  end
  
  // two state listeners used to send events
  class MyEventListener extends ECBehaviorTwoStateAnimated.DefaultListener
    class Factory implements ECBehaviorTwoStateAnimated.ActionConditionFactory
      public var ECBehaviorStateMachine stateMachine
      
      func new(ECBehaviorStateMachine stateMachine)
        this.stateMachine = stateMachine
      end
      
      func ECBehaviorTwoStateAnimated.Listener createListener(ECBehaviorTwoStateAnimated.Instance instance)
        return MyEventListener.new(stateMachine.instance(instance.getElement()))
      end
    end
    
    public var ECBehaviorStateMachine.Instance stateMachine
    
    func new(ECBehaviorStateMachine.Instance stateMachine)
      this.stateMachine = stateMachine
    end
    
    func void stopActivate(ECBehaviorTwoStateAnimated.Instance instance)
      stateMachine.runEvent("animated activated")
    end
    
    func void stopDeactivate(ECBehaviorTwoStateAnimated.Instance instance)
      stateMachine.runEvent("animated deactivated")
    end
  end
end

Example of the Multiple State Machine Usage.

class MyElementClass extends BehaviorElementClass
  func new()
    var ECBehaviorStateMachine smSpecific = ECBehaviorStateMachine.new(this, "specific")
    smSpecific.getPath().setValue("/content/mySpecificBehavior.desm")
    
    var ECBehaviorStateMachine smGeneric = ECBehaviorStateMachine.new(this, "idle")
    smGeneric.getPath().setValue("/content/myGenericBehavior.desm")
    
    // here you can add now behaviors assigining actions and conditions for both
    // state machines to use
    ...
    
    // add listeners to behaviors to send events to the state machine. the same
    // MyEventListener is used as in the single state machine example. the example
    // here uses two animated behaviors each sending events to one of the state
    // machines. in general using multiple state machines the events should be
    // disjoint but it is fully valid to send the same event to both if the
    // state machines are written to deal with this properly.
    var ECBehaviorTwoStateAnimated animated1 = ...
    animated1.addActionConditionFactory(MyEventListener.Factory.new(smSpecific))
    
    var ECBehaviorTwoStateAnimated animated2 = ...
    animated2.addActionConditionFactory(MyEventListener.Factory.new(smGeneric))
  end
end

The above example loads and runs two state machines. The first one is running specific state machine. The second state machine provides two separate state machines able to handle multiple logic at the same time. By writing the state machines properly the two state machienes do not interfere with each other and allow to split up state machines into multiple ones which can help create complex logic more simple and stable.

Action and Condition Factory

This example shows how to use a factory to add a condition checking for a trigger and an action manipulating a trigger.

class MyElementClass extends BehaviorElementClass
  func new()
    var ECBehaviorStateMachine smbehavior = ECBehaviorStateMachine.new(this)
    smbehavior.getPath().setValue("/content/mySpecificBehavior.desm")
    
    // add factory to create actions and conditions later on. this example uses
    // a code block for simplicity. using classes implementing ActionConditionFactory
    // is preferred since it allows to reuse factories across element classes.
    smbehavior.setActionConditionFactory(block ECBehaviorStateMachine.Instance instance
      // add condition evaluating to true if "player.insideZone" trigger is in fired state.
      // the condition can be used in the state machine using the name "player is inside zone".
      instance.setCondition("player is inside zone", SMConditionTrigger.new(\
        "player.insideZone", SMConditionTrigger.TestMode.fired))
      
      // add action pulsing (fire and immediately reset) "player.damage" trigger.
      // the action can be run in the state machine using the name "hurt playe".
      instance.setAction("hurt player", SMActionTrigger.new("player.damage", SMActionTrigger.Action.pulse))
    end)
  end
end

Using element class supporting adding behaviors the behavior can be added like this:

<?xml version='1.0' encoding='UTF-8'?>
<elementClass name='MyClass' class='GenericBehaviorElement'>
  <behavior type='ECBehaviorStateMachine'>
    <!-- set element properties. omit property prefix if used inside behavior tag -->
    <string name='.path'>actor.desm</string>
  </behavior>
 
  <!-- for adding multiple behaviors use unique identifiers -->
  <behavior type='ECBehaviorStateMachine' id='second'/>
</elementClass>

• DEExamples Repository: Element class changing color using a state machine receiving trigger events.
  • StateMachineExampleClass.ds
  • colorizer.desm