Drag[en]gine Wiki

User Tools

Site Tools

Trace:
dragengine:modules:dragonscript:behavior_toggle

Differences

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

Link to this comparison view

Next revision		Previous revision
dragengine:modules:dragonscript:behavior_toggle [2025/03/13 16:30] – created dragonlorddragengine:modules:dragonscript:behavior_toggle [2025/05/04 13:50] (current) – [toggle.check] dragonlord
Line 1: Line 1:
 {{tag>dragonscript behavior}} {{tag>dragonscript behavior}}
 <WRAP youarehere> <WRAP youarehere>
-[[:start|Start Page]] >> [[main|DragonScript Scripting Language]] >> [[abstractions#behavior_elementsquick_and_easy_development|Behavior Elements: Quick and Easy Development]] >> **ECBehaviorToggle**+[[:start|Start Page]] >> [[main|DragonScript Scripting Language]] >> [[dragengine:modules:dragonscript:abstractions|Abstraction Layers: How you want to build your Game]] >> [[dragengine:modules:dragonscript:behavior_elements|Behavior Elements]] >> **ECBehaviorToggle**
 </WRAP> </WRAP>
  
Line 51: Line 51:
  
 ===== toggled ===== ===== toggled =====
 +
 +Trigger target toggled.
 +
 +====== Behavior Tree Actions ======
 +
 +This behavior adds these behavior tree actions if behavior tree is present. If behavior has non-empty identifier replace ''toggle'' with ''toggle(id)''.
 +
 +===== toggle.set =====
 +
 +Set one or more toggle trigger parameters.
 +
 +^Parameter^Value^Description^
 +|target|''fire'', ''reset'', ''fullReset'', ''toggle''|Fire, reset, full reset or toggle target|
 +
 +This is an example of using this action:
 +<code xml>
 +<action name='toggle.set'>
 +  <parameter name='target'>toggle</parameter>
 +</action>
 +</code>
 +
 +===== toggle.check =====
 +
 +Check one or more toggle trigger parameters. Action succeeds if all parameter value matches their respective toggle trigger parameter otherwise action fails. This action is typically used as first action in a sequence to run the sequence only if a toggle trigger parameter matches (or not).
 +
 +^Parameter^Value^Description^
 +|trigger|''true'', ''false''|Trigger expression evaluates to true or false|
 +|target.fired|''true'', ''false''|Target is in fired or reset state|
 +|target.everFired|''true'', ''false''|Target has been fired at least once or never|
 +|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:
 +<code xml>
 +<sequence>
 +  <action name='toggle.check'>
 +    <parameter name='target.fired'>false</parameter>
 +    <parameter name='target.everFired'>false</parameter>
 +  </action>
 +  <!-- actions here run only if target is in reset state and has been never fired yet -->
 +</sequence>
 +</code>
 +
 +====== Behavior Tree Conditions ======
 +
 +This behavior adds these behavior tree conditions if behavior tree is present. If behavior has non-empty identifier replace ''toggle'' with ''toggle(id)''.
 +
 +===== toggle.check =====
 +
 +Check one or more toggle trigger parameters. Conditions returns true if all parameter value match their respective toggle trigger parameter. This condition is typically used to run an action or sequence of actions as long as toggle trigger conditions are true.
 +
 +^Parameter^Value^Description^
 +|toggle.trigger|''true'', ''false''|Trigger expression toggles to true or false|
 +|toggle.target.fired|''true'', ''false''|Target is in fired or reset state|
 +|toggle.target.everFired|''true'', ''false''|Target has been fired at least once or never|
 +
 +This is an example of using this condition:
 +<code xml>
 +<action name='myAction' id='doing something'>
 +  <parameter name='target.fired'>false</parameter>
 +  <parameter name='target.everFired'>false</parameter>
 +  <condition>toggle.check</condition>
 +</action>
 +</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 ''toggle'' with ''toggle(id)''.
 +
 +===== toggle.toggled =====
  
 Trigger target toggled. Trigger target toggled.
Line 60: Line 137:
 ====== Optional Behaviors ====== ====== Optional Behaviors ======
  
-This behavior does not support optional behaviors.+  * [[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 99: Line 177:
                    default is 'default' -->                    default is 'default' -->
     <string name='triggerTable'>default</string>     <string name='triggerTable'>default</string>
 +    
 +    <!-- optional: identifier of ECBehaviorTriggered to synchronize with or empty
 +                   string to not synchronize. default is empty 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_toggle.1741883448.txt.gz · Last modified: 2025/03/13 16:30 by dragonlord

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International
CC Attribution-Noncommercial-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki