Behavior element behavior adding hearing sounds support.

Uses a SoundLevelMeter resources to hear what sounds are playing in the audible range of the element.

SoundLevelMeter resources take sound properties of the environment into account like occlusion and how sound propagates through the world geometry. This allows game entities to hear the world similar to how a player hears the world what goes for sound volumes.

The SoundLevelMeter resource can be queried for the speakers currently in audible range and the volume they exhibit. Advanced effects audible to players like frequency band specific gains or special effects are disregarded. Furthermore speakers entering and leaving trigger a notification allowing elements to track elements of interest.

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

The behavior retrieves the owner of Speakers inside the audible range. If these owners are elements they are stored in a list of elements heared by the owner element. This list is updated when elements enter or leave the audible range. The volume of an element can be queried if required but is not stored.

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

This behavior can be used only once on an element.

Element class properties have the prefix hearSound. .

Audible distance in meters.

• Full name: hearSound.audibleDistance
• Type: float
• Default Value: 100
• Restriction: At least 1
• Example (*.deeclass)

  <float name='hearSound.audibleDistance'>50</float>

Volume threshold required for elements to be considered audible.

• Full name: hearSound.volumeThreshold
• Type: float
• Default Value: 0.01
• Restriction: At least 1
• Example (*.deeclass)

  <float name='hearSound.volumeThreshold'>0.02</float>

Position to attach resource to collider.

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

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

Orientation to attach resource to collider in degrees.

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

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

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

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

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

Element become audible.

Element became inaudible.

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

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

This is an example of using this action:

<sequence>
  <action name='hearSound.check'>
    <parameter name='player'>true</parameter>
  </action>
  <!-- actions here run only if player is audible by element -->
</sequence>

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

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

This is an example of using this condition:

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

Same as Behavior Tree Actions.

Same as Behavior Tree Conditions.

This behavior sends these state machine events.

Element become audible.

Element became inaudible.

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).

ECBehaviorHearSounds.

Since DragonScript Module Version 1.0

• Detect if element is hearing sounds.

This example defines an element which can detect hearing sounds.

class MyElement extends BehaviorElementClass
  public var ECBehaviorComponent component
  public var ECBehaviorCollider collider
  public var ECBehaviorHearSounds hearSounds
  func new()
    component = ECBehaviorComponent.new(this, null)
    collider = ECBehaviorCollider.new(this, component)
    headSounds = ECBehaviorHearSounds.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='ECBehaviorHearSounds'>
    <!-- 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='.audibleDistance'>50</float>
  </behavior>
</elementClass>

• DEExamples Repository