Behavior adding hit-scan support to elements.

Behavior supports using one or more collider collision tests to do one or more hit scans for example to check for weapon projectile impacts. Hit scans are done once then the result can be examine. To use this behavior add ECBehaviorCollider then this behavior. The collider is used to carry the collision tests.

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

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

Set test range.

• Full name: hitScan.range or hitScan({id}).range
• Type: float
• Default Value: 20
• Restriction: At least 0
• Example (*.deeclass)

  <float name='hitScan.range'>0.5</float>

Set test origin offset.

• Full name: hitScan.offset or hitScan({id}).offset
• Type: float
• Default Value: 0
• Restriction: At least 0
• Example (*.deeclass)

  <float name='hitScan.offset'>0.5</float>

Set test origin.

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

  <vector name='hitScan.origin' x='0' y='0' z='0.2'/>

Set test direction.

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

  <vector name='hitScan.direction' x='0' y='0' z='0.2'/>

Set test orientation.

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

  <vector name='hitScan.orientation' x='20' y='0' z='0'/>

Set test bone.

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

  <string name='hitScan.bone'>value</string>

This behavior has no events

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

Start hit scans.

This is an example of using this action:

<action name='hitScan.start'>
  <parameter name='type'>cone</parameter>
  <parameter name='count'>10</parameter>
  <parameter name='angle'>5</parameter>
</action>

Stop hit scans.

This is an example of using this action:

<action name='hitScan.stop'>
  <parameter name='clear'/>
</action>

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

This is an example of using this action:

<sequence>
  <action name='hitScan.check'>
    <parameter name='running'>false</parameter>
    <parameter name='hits.percentage.greater'>0.5</parameter>
  </action>
  <!-- actions here run only if hit scans finished and more than 50% hits have been found -->
</sequence>

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

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

This is an example of using this condition:

<action name='myAction' id='doing something'>
  <parameter name='hitScan.running'>false</parameter>
  <parameter name='hitScan.hits.percentage.greater'>0.5</parameter>
  <condition>hitScan.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 hitScan with hitScan(id).

Hit scan finished and the results can be examine now.

• ECBehaviorCollider: Collider to attach tests to.

• ECBehaviorComponent: Required if collision test has to originate from bone.
• 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). Saves selected color.

ECBehaviorHitScan.

Since DragonScript Module Version 1.0

• Line of sight tests.
• Test if a weapon hits a target.

This example defines an element which contains a hit scan.

class MyElement extends BehaviorElementClass
  public var ECBehaviorComponent component
  public var ECBehaviorCollider collider
  public var ECBehaviorHitScan hitScan
  func new()
    component = ECBehaviorComponent.new(this, null)
    collider = ECBehaviorCollider.new(this, component)
    hitScan = ECBehaviorHitScan.new(this, collider, component)
    hitScan.getRange().setValue(50)
  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='ECBehaviorHitScan'>
    <!-- optional: use component with id instead of empty string -->
    <string name='component'>second</string>
 
    <!-- optional: set collision filter. default value '1:0 1 2' which means
                   category BaseGameApp.CollisionFilterBit.dynamic
                   filter BaseGameApp.CollisionFilterBit.geometry,
                          BaseGameApp.CollisionFilterBit.dynamic,
                          BaseGameApp.CollisionFilterBit.actor.
                   format is '', 'category' or 'category:filter' where category and filter
                   are a list of bits to set. -->
    <string name='collisionFilter'>1:0 1 2</string>
 
    <!-- 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 -->
    <float name='.range'>50</float>
  </behavior>
 
  <!-- for adding multiple behaviors use unique identifiers -->
  <behavior type='ECBehaviorHitScan' id='second'/>
</elementClass>

• DEExamples Repository