Behavior element behavior adding touch sensor support.

Attaches a TouchSensor resource to the behavior element. By default the collision filter category is set to BaseGameApp.CollisionFilterBit.trigger and the collision filter mask is set to BaseGameApp.CollisionFilterBit.actorAI . This causes actors to trigger this touch sensor unless they have the CollisionFilterBit.trigger bit cleared. Modify the collision filter to allow other elements to trigger this touch sensor.

Upon being touched the touch sensor notifies the listeners.

The TouchSensor resource can be queried for the colliders currently touching it. Furthermore colliders entering and leaving trigger a notification allowing elements to track elements of interest.

If the ECBehaviorCollider behavior is present in the behavior element the TouchSensor is attached to the collider.

The behavior retrieves the owner of colliders inside the touch sensor. If these owners are elements they are stored in a list of elements touched by the owner element. This list is updated when elements enter or leave the touch sensor.

The owner behavior element as well as other ECBehavior subclasses can add a listener to be notified if elements enter and exit the touch sensor.

This element behavior can be present multiple times in a BehaviorElement. In this case use a unique identifier to distinguish the individual touch sensors.

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

Bone to attach resource to. If empty string attach to collider.

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

  <string name='touchSensor.bone'>attach</string>

Set collision filter. Filter bits are defined using a list of names mapped to collision filter bit indices using BaseGameApp.getCollisionFilterMap().

• Full name: collider.collisionFilter
• Type: string. Format can be category:filter or category where category and filter can be bit1 bit2 … bitN with bit names looked up using the collision filter map. If only category is used filter is the same.
• Default Value: trigger:actorAI
• Example (*.deeclass)

  <string name='collider.collisionFilter'>trigger:actorAI particle</string>

Orientation to attach resource to collider in degrees.

• Full name: touchSensor.orientation or touchSensor({id}).orientation
• Type: 3-component float vector
• Default Value: (0,0,0)
• Example (*.deeclass)

  <vector name='touchSensor.orientation' x='30' y='0' z='0'/>

Position to attach resource to collider.

• Full name: touchSensor.position or touchSensor({id}).position
• Type: 3-component float vector
• Default Value: (0,0,0)
• Example (*.deeclass)

  <vector name='touchSensor.position' x='0' y='0' z='0.1'/>

Touch sensor shape.

• Full name: touchSensor.shape or touchSensor({id}).shape
• Type: string (shape format). See “Shape List Encoding” in CodecPropertyString.
• Default Value: empty string
• Example (*.deeclass)

  <string name='touchSensor.shape'>box:position,0,0.5,0:extends,2,1,0.5</string>

Set shape to box matching the element size.

• Full name: touchSensor.shapeFromSize or touchSensor({id}).shapeFromSize
• Type: boolean
• Default Value: false
• Example (*.deeclass)

  <boolean name='touchSensor.shapeFromSize'>true</boolean>

Enable touch sensor.

• Full name: touchSensor.touching or touchSensor({id}).touching
• Type: boolean
• Default Value: true
• Example (*.deeclass)

  <boolean name='touchSensor.touching'>false</boolean>

Element entered touch sensor.

Element left touch sensor.

Element can touch this touch sensor if all listeners return true.

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

Set one or more touch sensor parameters.

This is an example of using this action:

<action name='touchSensor.set'>
  <parameter name='enabled'>true</parameter>
</action>

Update touch sensor.

This is an example of using this action:

<action name='touchSensor.set'>
  <parameter name='enabled'>true</parameter>
</action>

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

This is an example of using this action:

<sequence>
  <action name='touchSensor.check'>
    <parameter name='player'>true</parameter>
  </action>
  <!-- actions here run only if player is touching touch sensor -->
</sequence>

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

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

This is an example of using this condition:

<action name='myAction' id='doing something'>
  <parameter name='touchSensor.player'>true</parameter>
  <condition>touchSensor.check</condition>
</action>

Same as Behavior Tree Actions.

Same as Behavior Tree Conditions.

This behavior sends these state machine events. If behavior has non-empty identifier replace touchSensor with touchSensor(id).

Element entered touch sensor. Element is send as event parameter.

Element left touch sensor. Element is send as event parameter.

This behavior requires no other behaviors.

• ECBehaviorCollider: Attach to collider.
• 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).

ECBehaviorTouchSensor.

Since DragonScript Module Version 1.0

• Detect touching elements.

This example defines an element which can detect touching elements.

class MyElement extends BehaviorElementClass
  public var ECBehaviorComponent component
  public var ECBehaviorCollider collider
  public var ECBehaviorTouchSensor touchSensor
  func new()
    component = ECBehaviorComponent.new(this, null)
    collider = ECBehaviorCollider.new(this, component)
    touchSensor = ECBehaviorTouchSensor.new(this, collider)
  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='ECBehaviorComponent'/>
  <behavior type='ECBehaviorCollider'/>
 
  <behavior type='ECBehaviorTouchSensor'>
    <!-- optional: use behavior tree with id instead of empty string -->
    <string name='behaviorTree'>second</string>
 
    <!-- optional: use state machine with id instead of empty string -->
    <string name='stateMachine'>second</string>
 
    <!-- set element properties. omit property prefix if used inside behavior tag -->
    <boolean name='.shapeFromSize'>true</boolean>
  </behavior>
 
  <!-- for adding multiple behaviors use unique identifiers -->
  <behavior type='ECBehaviorTouchSensor' id='second'/>
</elementClass>

• DEExamples Repository