User Tools

Site Tools


dragengine:modules:dragonscript:behavior_vrhand

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
dragengine:modules:dragonscript:behavior_vrhand [2025/03/13 17:17] dragonlorddragengine:modules:dragonscript:behavior_vrhand [2025/05/14 10:34] (current) dragonlord
Line 55: Line 55:
  
 Hand controller detached and no more usable. Hand controller detached and no more usable.
 +
 +====== Behavior Tree Actions ======
 +
 +This behavior adds these behavior tree actions if behavior tree is present. If behavior has non-empty identifier replace ''vrHand'' with ''vrHand(id)''.
 +
 +===== vrHand.check =====
 +
 +Check one or more VR hand parameters. Action succeeds if all parameter value matches their respective VR hand parameter otherwise action fails. This action is typically used as first action in a sequence to run the sequence only if a VR hand parameter matches (or not).
 +
 +^Parameter^Value^Description^
 +|attached|''true'', ''false''|VR controller is attached|
 +|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='vrHand.check'>
 +    <parameter name='attached'>true</parameter>
 +  </action>
 +  <!-- actions here run only if VR hand controller is attached -->
 +</sequence>
 +</code>
 +
 +====== Behavior Tree Conditions ======
 +
 +This behavior adds these behavior tree conditions if behavior tree is present. If behavior has non-empty identifier replace ''vrHand'' with ''vrHand(id)''.
 +
 +===== vrHand.check =====
 +
 +Check one or more VR hand parameters. Conditions returns true if all parameter value match their respective VR hand parameter. This condition is typically used to run an action or sequence of actions as long as VR hand conditions are true.
 +
 +^Parameter^Value^Description^
 +|vrHand.attached|''true'', ''false''|VR controller is attached|
 +
 +This is an example of using this condition:
 +<code xml>
 +<action name='myAction' id='doing something'>
 +  <parameter name='vrHand.attached'>true</parameter>
 +  <condition>vrHand.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 ''vrHand'' with ''vrHand(id)''.
 +
 +===== vrHand.attached =====
 +
 +VR controller has been attached.
 +
 +===== vrHand.disabled =====
 +
 +VR controller has been detached.
  
 ====== Required Behaviors ====== ====== Required Behaviors ======
Line 62: Line 123:
 ====== 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 122: Line 184:
                    where category and filter are a list of bits to set. -->                    where category and filter are a list of bits to set. -->
     <string name='collisionFilter'>6:0 1 2 3 5</string>     <string name='collisionFilter'>6:0 1 2 3 5</string>
 +    
 +    <!-- optional: add behavior trees. default adds all behavior trees. -->
 +    <list name='behaviorTrees'>
 +      <string/> <!-- add behavior with empty identifier -->
 +      <string>default</string> <!-- add behavior with 'default' identifier -->
 +    </list>
 +    
 +    <!-- optional: add state machines. default adds all state machines. -->
 +    <list name='stateMachines'>
 +      <string/> <!-- add behavior with empty identifier -->
 +      <string>default</string> <!-- add behavior with 'default' identifier -->
 +    </list>
          
     <!-- 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_vrhand.txt · Last modified: 2025/05/14 10:34 by dragonlord