User Tools

Site Tools


dragengine:modules:dragonscript:behavior_announcer

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
dragengine:modules:dragonscript:behavior_announcer [2025/05/01 17:56] – [Optional Behaviors] dragonlorddragengine:modules:dragonscript:behavior_announcer [2026/11/07 17:24] (current) – dragonlord
Line 133: Line 133:
   * Default Value: empty string   * Default Value: empty string
   * Example (*.deeclass) <code xml><string name='announcer.bone'>attach</string></code>   * Example (*.deeclass) <code xml><string name='announcer.bone'>attach</string></code>
 +
 +===== layerMask =====
 +Set layer mask with world layer bits to play audio on.
 +  * Full name: ''announcer.layerMask''
 +  * Type: string list
 +  * Default Value: ''audio''
 +  * Example (*.deeclass) <code xml><string name='announcer.layerMask'>audio music</string></code>
  
 ===== trigger ===== ===== trigger =====
Line 157: Line 164:
 This behavior adds these behavior tree actions if behavior tree is present. If behavior has non-empty identifier replace ''announcer'' with ''announcer(id)''. This behavior adds these behavior tree actions if behavior tree is present. If behavior has non-empty identifier replace ''announcer'' with ''announcer(id)''.
  
-===== announcer.announce =====+===== announcer.update =====
  
-Start or stop announcing.+Update announcer.
  
 ^Parameter^Value^Description^ ^Parameter^Value^Description^
Line 168: Line 175:
 This is an example of using this action: This is an example of using this action:
 <code xml> <code xml>
-<action name='announcer.announce'>+<action name='announcer.update'>
   <parameter name='text.translated'>announcer.welcome</parameter>   <parameter name='text.translated'>announcer.welcome</parameter>
 </action> </action>
Line 179: Line 186:
 ^Parameter^Value^Description^ ^Parameter^Value^Description^
 |announcing|''true'', ''false''|Announcer is announcing| |announcing|''true'', ''false''|Announcer is announcing|
 +|wait| |If present action returns BTResult.running instead of BTResult.failed to wait until the checks are all fulfilled|
  
 This is an example of using this action: This is an example of using this action:
Line 208: Line 216:
 </action> </action>
 </code> </code>
 +
 +====== State Machine Actions ======
 +
 +Same as [[#behavior_tree_actions|Behavior Tree Actions]].
 +
 +====== State Machine Conditions ======
 +
 +Same as [[#behavior_tree_conditions|Behavior Tree Conditions]].
 +
 +====== State Machine Events ======
 +
 +This behavior sends these state machine events. If behavior has non-empty identifier replace ''announcer'' with ''announcer(id)''.
 +
 +===== announcer.start =====
 +
 +Start playing back announcement.
 +
 +===== announcer.stop =====
 +
 +Stop playing back announcement.
  
 ====== Required Behaviors ====== ====== Required Behaviors ======
Line 217: Line 245:
   * [[behavior_collider|ECBehaviorCollider]]: Attach to collider.   * [[behavior_collider|ECBehaviorCollider]]: Attach to collider.
   * [[behavior_behaviortree|ECBehaviorBehaviorTree]]: Add actions and conditions for behavior trees to use.   * [[behavior_behaviortree|ECBehaviorBehaviorTree]]: Add actions and conditions for behavior trees to use.
 +  * [[behavior_statemachine|ECBehaviorStateMachine]]: Add actions and conditions for state machine to use and events to send to the state machine.
  
 ====== Persistency ====== ====== Persistency ======
Line 269: Line 298:
                    string to not synchronize. default is empty string. -->                    string to not synchronize. default is empty string. -->
     <string name='trigger.synchronize'>other</string>     <string name='trigger.synchronize'>other</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 -->     <!-- set element properties. omit property prefix if used inside behavior tag -->
dragengine/modules/dragonscript/behavior_announcer.1746122190.txt.gz · Last modified: by dragonlord