User Tools

Site Tools


dragengine:modules:dragonscript:behavior_playerinputturn

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_playerinputturn [2025/03/13 17:15] dragonlorddragengine:modules:dragonscript:behavior_playerinputturn [2025/05/12 15:39] (current) dragonlord
Line 36: Line 36:
  
 This behavior has no events. This behavior has no events.
 +
 +====== Behavior Tree Actions ======
 +
 +This behavior adds these behavior tree actions if behavior tree is present.
 +
 +===== playerInputTurn.set =====
 +
 +Set one or more player input turn parameters.
 +
 +^Parameter^Value^Description^
 +|reset| |Reset player input turn|
 +|left|''true'', ''false''|Left turn key pressed|
 +|left.toggle| |Toggle left turn key pressed|
 +|right|''true'', ''false''|Right turn key pressed|
 +|right.toggle| |Toggle right turn key pressed|
 +|speed|float|Turn speed in m/s|
 +|analog|float, ''eventParam'', ''-eventParam''|Add analog turn value in the range from -180 to 180 degrees|
 +|analog.sticky|float, ''eventParam'', ''-eventParam''|Set sticky analog turn value in the range from -180 to 180 degrees|
 +|canTurn|''true'', ''false''|Can turn|
 +|canTurn.toggle| |Toggle can turn|
 +
 +This is an example of using this action:
 +<code xml>
 +<action name='playerInputTurn.set'>
 +  <parameter name='left'>true</parameter>
 +</action>
 +</code>
 +
 +===== playerInputTurn.update =====
 +
 +Update player input turn.
 +
 +^Parameter^Value^Description^
 +|locomotion| |Update locomotion applying calculateLookHorizontal() and calculateLookVertical() to [[behavior_locomotion|ECBehaviorLocomotion]].applyLookAround()|
 +
 +This is an example of using this action:
 +<code xml>
 +<action name='playerInputLook.update'>
 +  <parameter name='locomotion'/>
 +</action>
 +</code>
 +
 +===== playerInputTurn.check =====
 +
 +Check one or more player input turn parameters. Action succeeds if all parameter value matches their respective player input turn parameter otherwise action fails. This action is typically used as first action in a sequence to run the sequence only if a player input turn parameter matches (or not).
 +
 +^Parameter^Value^Description^
 +|left|''true'', ''false''|Left turn key pressed|
 +|speed.less|float|Speed is less than float value m/s|
 +|speed.greater|float|Speed is greater than float value m/s|
 +|analog.less|float|Analog value is less than float value degrees|
 +|analog.greater|float|Analog value is greater than float value degrees|
 +|analog.sticky.less|float|Sticky analog value is less than float value degrees|
 +|analog.sticky.greater|float|Sticky analog value is greater than float value degrees|
 +|canTurn|''true'', ''false''|Can turn|
 +|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='playerInputTurn.check'>
 +    <parameter name='left'>true</parameter>
 +  </action>
 +  <!-- actions here run only if left turn key is pressed -->
 +</sequence>
 +</code>
 +
 +====== Behavior Tree Conditions ======
 +
 +This behavior adds these behavior tree conditions if behavior tree is present.
 +
 +===== playerInputTurn.check =====
 +
 +Check one or more player input turn parameters. Conditions returns true if all parameter value match their respective player input turn parameter. This condition is typically used to run an action or sequence of actions as long as player input turn conditions are true.
 +
 +^Parameter^Value^Description^
 +|playerInputTurn.left|''true'', ''false''|Left turn key pressed|
 +|playerInputTurn.speed.less|float|Speed is less than float value m/s|
 +|playerInputTurn.speed.greater|float|Speed is greater than float value m/s|
 +|playerInputTurn.analog.less|float|Analog value is less than float value degrees|
 +|playerInputTurn.analog.greater|float|Analog value is greater than float value degrees|
 +|playerInputTurn.analog.sticky.less|float|Sticky analog value is less than float value degrees|
 +|playerInputTurn.analog.sticky.greater|float|Sticky analog value is greater than float value degrees|
 +|playerInputTurn.canTurn|''true'', ''false''|Can turn|
 +
 +This is an example of using this condition:
 +<code xml>
 +<action name='myAction' id='doing something'>
 +  <parameter name='playerInputTurn.left'>true</parameter>
 +  <condition>playerInputTurn.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 send no events to state machine.
  
 ====== Required Behaviors ====== ====== Required Behaviors ======
Line 44: Line 148:
  
   * [[behavior_locomotion|ECBehaviorLocomotion]]: Update locomotion turning parameters.   * [[behavior_locomotion|ECBehaviorLocomotion]]: Update locomotion turning parameters.
 +  * [[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 79: Line 185:
 <elementClass name='MyClass' class='GenericBehaviorElement'> <elementClass name='MyClass' class='GenericBehaviorElement'>
   <behavior type='ECBehaviorPlayerInputTurn'>   <behavior type='ECBehaviorPlayerInputTurn'>
 +    <!-- 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 -->
     <string name='.name'>Color 1</string>     <string name='.name'>Color 1</string>
dragengine/modules/dragonscript/behavior_playerinputturn.1741886124.txt.gz · Last modified: 2025/03/13 17:15 by dragonlord