Drag[en]gine Wiki

User Tools

Site Tools

Trace:
dragengine:modules:dragonscript:behavior_projecttoground

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_projecttoground [2025/03/13 17:10] – dragonlorddragengine:modules:dragonscript:behavior_projecttoground [2025/05/13 13:59] (current) – old revision restored (2025/05/11 13:20) dragonlord
Line 27: Line 27:
   * Default Value: true   * Default Value: true
   * Example (*.deeclass) <code xml><boolean name='projectToGround.applyToActor'>false</boolean></code>   * Example (*.deeclass) <code xml><boolean name='projectToGround.applyToActor'>false</boolean></code>
 +
 +===== landingAngle =====
 +
 +Set landing angle in degrees. Used to check during collision response if an actor is landing on ground. This is done by comparing the impact normal of the ground against the project-to-ground direction. If this angle is small enough the actor is considered to land on ground instead of flying against a wall or scratching the ground in an upwards motion.
 +
 +  * Full name: ''projectToGround.landingAngle''
 +  * Type: float
 +  * Restriction: At least 0 and at most 180
 +  * Default Value: 120
 +  * Example (*.deeclass) <code xml><float name='projectToGround.landingAngle'>120</float></code>
  
 ====== Events ====== ====== Events ======
Line 39: Line 49:
  
 Actor switched between touching ground and not touching ground. Actor switched between touching ground and not touching ground.
 +
 +====== Behavior Tree Actions ======
 +
 +This behavior adds these behavior tree actions if behavior tree is present.
 +
 +===== projectToGround.set =====
 +
 +Set one or more project to ground parameters.
 +
 +^Parameter^Value^Description^
 +|enabled|''true'', ''false''|Project to ground is enabled|
 +|ground|''true'', ''false''|Touching ground|
 +
 +This is an example of using this action:
 +<code xml>
 +<sequence>
 +  <action name='projectToGround.set'>
 +    <parameter name='enabled'>true</parameter>
 +  </action>
 +</sequence>
 +</code>
 +
 +===== projectToGround.update =====
 +
 +Update project to ground.
 +
 +^Parameter^Value^Description^
 +|interactElement.assign|string|Assign ground element to [[behavior_interactelement|ECBehaviorInteractElement]] with identifier matching value string. Action fails if not touching element or interact element behavior is absent|
 +|interact|string|Interact with ground element. If element is absent action fails. Runs interaction with name value. If interaction with name value is absent fails action. If interaction returns false fails action. Otherwise action succeeds.|
 +|interact.parameters|string|Optional parameters to use with ''interaction''.|
 +
 +
 +This is an example of using this action:
 +<code xml>
 +<sequence>
 +  <action name='projectToGround.set'>
 +    <parameter name='interactElement.assign'/>
 +  </action>
 +</sequence>
 +</code>
 +
 +===== projectToGround.check =====
 +
 +Check one or more project to ground parameters. Action succeeds if all parameter value matches their respective project to ground parameter otherwise action fails. This action is typically used as first action in a sequence to run the sequence only if a project to ground parameter matches (or not).
 +
 +^Parameter^Value^Description^
 +|enabled|''true'', ''false''|Project to ground is enabled|
 +|ground|''true'', ''false''|Touching ground|
 +|ground.element|''true'', ''false''|Last ground collider is not null and collider owner is castable to BehaviorElement|
 +|hitAngle.less|float|Angle between collision normal and project to ground direction is less than value in degrees|
 +|hitAngle.greater|float|Angle between collision normal and project to ground direction is greater than value in degrees|
 +|landing|''true'', ''false''|Angle between collision normal and project to ground direction is less than ''landingAngle'' property|
 +|interact.name|string|Name of interaction|
 +|interact.has|''true'', ''false''|Has ground element and interaction with name ''interaction.name'' is present|
 +|interact.query|''true'', ''false''|Interact with ground element and test result. Condition is true if ground element is present, interaction with name ''interaction.name'' is present and interaction returns true. It is recommended to use here only interactions without side effects (hence query interactions).|
 +|interact.parameters|string|Optional parameters to use with ''interaction.query''.|
 +|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='projectToGround.check'>
 +    <parameter name='ground'>true</parameter>
 +  </action>
 +  <!-- actions here run only if touching ground -->
 +</sequence>
 +</code>
 +
 +====== Behavior Tree Conditions ======
 +
 +This behavior adds these behavior tree conditions if behavior tree is present.
 +
 +===== projectToGround.check =====
 +
 +Check one or more project to ground parameters. Conditions returns true if all parameter value match their respective project to ground parameter. This condition is typically used to run an action or sequence of actions as long as project to ground conditions are true.
 +
 +^Parameter^Value^Description^
 +|projectToGround.enabled|''true'', ''false''|Project to ground is enabled|
 +|projectToGround.ground|''true'', ''false''|Touching ground|
 +|projectToGround.ground.element|''true'', ''false''|Found ground element during last test|
 +|projectToGround.hitAngle.less|float|Angle between collision normal and project to ground direction is less than value in degrees|
 +|projectToGround.hitAngle.greater|float|Angle between collision normal and project to ground direction is greater than value in degrees|
 +|projectToGround.landing|''true'', ''false''|Angle between collision normal and project to ground direction is less than ''landingAngle'' property|
 +|projectToGround.interact.name|string|Name of interaction|
 +|projectToGround.interact.has|''true'', ''false''|Has ground element and interaction with name ''interaction.name'' is present|
 +|projectToGround.interact.query|''true'', ''false''|Interact with ground element and test result. Condition is true if ground element is present, interaction with name ''interaction.name'' is present and interaction returns true. It is recommended to use here only interactions without side effects (hence query interactions).|
 +|projectToGround.interact.parameters|string|Optional parameters to use with ''interaction.query''.|
 +
 +This is an example of using this condition:
 +<code xml>
 +<action name='myAction' id='doing something'>
 +  <parameter name='projectToGround.enabled'>true</parameter>
 +  <condition>projectToGround.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.
 +
 +===== projectToGround.enabled =====
 +
 +Project to ground has been enabled.
 +
 +===== projectToGround.disabled =====
 +
 +Project to ground has been disabled.
 +
 +===== projectToGround.touch =====
 +
 +Element is touching ground while previously has not been touching ground.
 +
 +===== projectToGround.noTouch =====
 +
 +Element is not touching ground while previously has been touching ground.
  
 ====== Required Behaviors ====== ====== Required Behaviors ======
Line 46: Line 179:
 ====== 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 92: Line 226:
      
   <behavior type='ECBehaviorProjectToGround'>   <behavior type='ECBehaviorProjectToGround'>
 +    <!-- 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 -->
     <boolean name='.applyToActor'>false</boolean>     <boolean name='.applyToActor'>false</boolean>
dragengine/modules/dragonscript/behavior_projecttoground.1741885805.txt.gz · Last modified: 2025/03/13 17:10 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