User Tools

Site Tools


dragengine:modules:dragonscript:behavior_evaluate

This is an old revision of the document!


ECBehaviorEvaluate

Behavior element behavior evaluating trigger expression.

Fires and resets a trigger target depending on the evaluation state of a trigger expression. Optionally pulses trigger target instead of just firing it.

Instance Counts

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

Element Class Properties

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

trigger

Trigger to evaluate.

  • Full name: evaluate.trigger or evaluate({id}).trigger
  • Type: string
  • Default Value: empty string
  • Example (*.deeclass)
    <string name='evaluate.trigger'>@switchOnVent & @powerEnabled</string>

target

Fires target if trigger evaluates to true otherwise resets it.

  • Full name: evaluate.target or evaluate({id}).target
  • Type: string
  • Default Value: empty string
  • Example (*.deeclass)
    <string name='evaluate.target'>ventOn</string>

pulse

Pulse target instead of toggle fired state.

  • Full name: evaluate.pulse or evaluate({id}).pulse
  • Type: boolean
  • Default Value: false
  • Example (*.deeclass)
    <boolean name='evaluate.pulse'>true</boolean>

Events

evaluatesTrue

Trigger expression changed to true.

evaluatesFalse

Trigger expression changed to false.

Behavior Tree Actions

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

evaluate.check

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

ParameterValueDescription
triggertrue, falseTrigger expression evaluates to true or false
target.firedtrue, falseTarget is in fired or reset state
target.everFiredtrue, falseTarget has been fired at least once or never

This is an example of using this action:

<sequence>
  <action name='evaluate.check'>
    <parameter name='target.fired'>false</parameter>
    <parameter name='target.everFired'>false</parameter>
  </action>
  <!-- actions here run only if target is in reset state and has been never fired yet -->
</sequence>

Behavior Tree Conditions

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

evaluate.check

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

ParameterValueDescription
evaluate.triggertrue, falseTrigger expression evaluates to true or false
evaluate.target.firedtrue, falseTarget is in fired or reset state
evaluate.target.everFiredtrue, falseTarget has been fired at least once or never

This is an example of using this condition:

<action name='myAction' id='doing something'>
  <parameter name='evaluate.target.fired'>false</parameter>
  <parameter name='evaluate.target.everFired'>false</parameter>
  <condition>evaluate.check</condition>
</action>

Required Behaviors

This behavior requires no other behaviors.

Optional Behaviors

This behavior does not support optional behaviors.

Persistency

This behavior does not required element class to be persistable (setPersistable).

API Documentation

ECBehaviorEvaluate.

Since DragonScript Module Version 1.0

Use Cases

  • Add support to firet target if trigger evaluates to true.

Element Class Example

This example defines an element which evaluates trigger.

class MyElement extends BehaviorElementClass
  public var ECBehaviorEvaluate evaluate
  func new()
    evaluate = ECBehaviorEvaluate.new(this)
  end
end

Behavior Factory

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='ECBehaviorEvaluate'>
    <!-- optional: use BaseGameApp trigger table. game can add more supported values.
                   default is 'default' -->
    <string name='triggerTable'>default</string>
 
    <!-- optional: identifier of ECBehaviorTriggered to synchronize with or empty
                   string to not synchronize. default is empty string. -->
    <string name='trigger.synchronize'>other</string>
 
    <!-- set element properties. omit property prefix if used inside behavior tag -->
    <string name='.target'>ventOn</string>
  </behavior>
 
  <!-- for adding multiple behaviors use unique identifiers -->
  <behavior type='ECBehaviorEvaluate' id='second'/>
</elementClass>

Live Examples

You could leave a comment if you were logged in.
dragengine/modules/dragonscript/behavior_evaluate.1746107607.txt.gz · Last modified: 2025/05/01 13:53 by dragonlord