Behavior element behavior adding timer support to behavior trees and state machines.

Adds actions, conditions and events allowing behavior trees and state machines to start, stop and wait for multiple independent named timers. Timers count down during think updates. A timer has elapsed once its remaining time reaches 0. Timers are persisted together with the element.

This behavior can be added only once to an element class.

This behavior has no element class properties.

This behavior adds these behavior tree actions if behavior tree is present.

Start or stop named timers. Action always succeeds.

This is an example of starting a timer:

<action name='timers.update'>
  <parameter name='start'>myTimer</parameter>
  <parameter name='timeout'>1.5</parameter>
</action>

This is an example of starting a timer using random timeout:

<action name='timers.update'>
  <parameter name='start'>myTimer</parameter>
  <parameter name='timeout.lower'>1.5</parameter>
  <parameter name='timeout.upper'>2.5</parameter>
</action>

This is an example of stopping a timer:

<action name='timers.update'>
  <parameter name='stop'>myTimer</parameter>
</action>

Check one or more timer parameters. Not existing timers are considered stopped. Action succeeds if all parameter values match their respective timer state otherwise action fails. This action is typically used as first action in a sequence to run the sequence only if a timer condition matches (or not).

This is an example of checking if a timer is running:

<action name='timers.check' id='waiting'>
  <parameter name='timer'>myTimer</parameter>
  <parameter name='running'>true</parameter>
</action>

This is an example of waiting until a timer has elapsed:

<action name='timers.check' id='waiting'>
  <parameter name='timer'>myTimer</parameter>
  <parameter name='running'>false</parameter>
  <parameter name='wait'/>
</action>

This behavior adds these behavior tree conditions if behavior tree is present.

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

This is an example of using this condition:

<action name='myAction' id='doing something'>
  <condition>timers.check</condition>
  <parameter name='timers.timer'>myTimer</parameter>
  <parameter name='timers.running'>true</parameter>
</action>

Same as Behavior Tree Actions.

Same as Behavior Tree Conditions.

This behavior sends these state machine events.

Timer named name has elapsed. The event is sent once after the timer reached 0 remaining time. The name of the timer is appended to the event name.

This is an example of a transition that runs if the timer “myTimer” has elapsed:

<transition event='timers.elapsed:myTimer' state='nextState'>
</transition>

This behavior requires no other behaviors.

• ECBehaviorBehaviorTree: Add actions and conditions for behavior trees to use.
• ECBehaviorStateMachine: Add actions and conditions for state machine to use and events to send to the state machine.

This behavior does support element class to be persistable (setPersistable). Running timers are persisted.

ECBehaviorBTSMTimers.

Since DragonScript Module Version 1.35

• Delay an action, for example close a door a few seconds after it has been opened.
• Let a state machine switch state after a timeout, for example leave an idle state after some time.
• Add random delays using timeout.lower and timeout.upper.

This example defines an element which contains timers.

class MyElement extends BehaviorElementClass
  public var ECBehaviorBTSMTimers timers
  func new()
    timers = ECBehaviorBTSMTimers.new(this)
  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='ECBehaviorBTSMTimers'>
    <!-- optional: add behavior trees. default adds all behavior trees. -->
    <list name='behaviorTrees'>
      <string/> <!-- add behavior with empty identifier -->
      <string>default</string> <!-- add behavior with 'default' identifier -->
    </list>
 
    <!-- optional: add state machines. default adds all state machines. -->
    <list name='stateMachines'>
      <string/> <!-- add behavior with empty identifier -->
      <string>default</string> <!-- add behavior with 'default' identifier -->
    </list>
  </behavior>
</elementClass>

• DEExamples Repository