Behavior element behavior adding announcer support.

Behavior uses an Announcer to play back announcer files. The speaker created by the Announcer instance is added to the game world.

If the ECBehaviorCollider is present the announcer speaker is attached. The speaker is attached to the named bone if defined otherwise it is attached statically.

This behavior contains a property to set the announcement text. Other behaviors can change this text at runtime to make this alter the announcement. Changing the announcement text will stop playing back the current announcement.

This behavior can be added multiple times to an element. Each instance creates one announcer speaker attached to the element collider which can be individually modified. To distinguish the announcers each instance has an identifier which can be used to retrieve a specific instance.

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

Path to announcer file to load.

• Full name: announcer.path or announcer({id}).path
• Type: string
• Default Value: empty string
• Expected File Type: *.announcer.xml
• Example (*.deeclass)

  <string name='announcer.path'>speaker.announcer.xml</string>

Speaker type.

• Full name: announcer.type or announcer({id}).type
• Type: enumeration

• Allowed Values:

  Value	Description
  point	Omnidirectional.
  directed	Directed.

• Default Value: point
• Example (*.deeclass)

  <string name='announcer.type'>directed</string>

Speaker volume.

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

  <float name='announcer.volume'>0.8</float>

Speaker range in meters. Speaker is inaudible beyond range.

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

  <float name='announcer.range'>20</float>

Roll off. Value 1 is realistic (normal) roll-off. Values larger than 1 reduce volume faster near the sound source. Values smaller than 1 reduce volume faster near the sound range.

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

  <float name='announcer.rollOff'>1.5</float>

Distance offset for attenuation calculation. For use by distance sounds. Offsets the true distance to the sound source for attenuation calculation to make the sound appear coming from far away. Requires increasing the volume to compensate for the distance increased attenuation.

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

  <float name='announcer.distanceOffset'>500</float>

Speaker shape.

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

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

Announcement text.

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

  <string name='announcer.text'>This is an announcement.</string>

Position to attach resource to collider.

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

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

Orientation to attach resource to collider in degrees.

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

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

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

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

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

Play announcement whenever trigger evaluates to true.

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

  <string name='announcer.trigger'>@switchOnVent & @powerEnabled</string>

Start playing back announcement.

Stop playing back announcement.

This behavior requires no other behaviors.

• ECBehaviorCollider: Attach to collider.

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

ECBehaviorAnnouncer.

Since DragonScript Module Version 1.0

• Play announcement through speaker composed of pre-recorded words.

This example defines an element which supports playing announcements.

class MyElement extends BehaviorElementClass
  public var ECBehaviorComponent component
  public var ECBehaviorCollider collider
  public var ECBehaviorAnnouncer announcer
  func new()
    component = ECBehaviorComponent.new(this, null)
    collider = ECBehaviorCollider.new(this, component)
    announcer = ECBehaviorAnnouncer.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='ECBehaviorAnnouncer'>
    <!-- optional: set layer mask (default '2' meaning BaseGameApp.WorldLayerBit.audio).
                   list of bits to set. -->
    <string name='layerMask'>0 1 4</string>
 
    <!-- optional: use BaseGameApp trigger table. game can add more supported values -->
    <string name='triggerTable'>default</string>
 
    <!-- set element properties. omit property prefix if used inside behavior tag -->
    <string name='.text'>This is an announcement.</string>
  </behavior>
 
  <!-- for adding multiple behaviors use unique identifiers -->
  <behavior type='ECBehaviorAnnouncer' id='second'/>
</elementClass>

• DEExamples Repository