Differences

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

--- dragengine:modules:dragonscript:behavior_rideon [2025/03/12 14:15] – created dragonlord
+++ dragengine:modules:dragonscript:behavior_rideon [2025/05/13 14:02] (current) – dragonlord
@@ Line 1: / Line 1: @@
 {{tag>dragonscript behavior}}
 <WRAP youarehere>
-[[:start|Start Page]] >> [[main|DragonScript Scripting Language]] >> [[abstractions#behavior_elementsquick_and_easy_development|Behavior Elements: Quick and Easy Development]] >> **ECBehaviorRideOn**
+[[: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]] >> **ECBehaviorRideOn**
 </WRAP>
@@ Line 28: / Line 28: @@
 Ridable changed. Element begins or stops touching a [[behavior_ridable|ECBehaviorRidable]].
+====== Behavior Tree Actions ======
+This behavior adds these behavior tree actions if behavior tree is present.
+===== rideOn.update =====
+Update ride on.
+^Parameter^Value^Description^
+|interact|string|Interact with ridable 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''.|
+|interactElement.assign|string|Assign ridable to [[behavior_interactelement|ECBehaviorInteractElement]] with identifier matching value string. Action fails if no element is ridable or interact element behavior is absent|
+This is an example of using this action:
+<code xml>
+<action name='lookAt.update'>
+  <parameter name='interactElement.assign'/>
+</action>
+</code>
+===== rideOn.check =====
+Check one or more ride on parameters. Action succeeds if all parameter value matches their respective ride on parameter otherwise action fails. This action is typically used as first action in a sequence to run the sequence only if a ride on parameter matches (or not).
+^Parameter^Value^Description^
+|ridable|''true'', ''false''|Riding on an element|
+|interact.name|string|Name of interaction|
+|interact.has|''true'', ''false''|Has ridable and interaction with name ''interaction.name'' is present|
+|interact.query|''true'', ''false''|Interact with ridable and test result. Condition is true if ridable 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='rideOn.check'>
+    <parameter name='ridable'>true</parameter>
+  </action>
+  <!-- actions here run only if riding on an element -->
+</sequence>
+</code>
+====== Behavior Tree Conditions ======
+This behavior adds these behavior tree conditions if behavior tree is present.
+===== rideOn.check =====
+Check one or more ride on parameters. Conditions returns true if all parameter value match their respective ride on parameter. This condition is typically used to run an action or sequence of actions as long as ride on conditions are true.
+^Parameter^Value^Description^
+|rideOn.ridable|''true'', ''false''|Riding on an element|
+|rideOn.interact.name|string|Name of interaction|
+|rideOn.interact.has|''true'', ''false''|Has ridable and interaction with name ''interaction.name'' is present|
+|rideOn.interact.query|''true'', ''false''|Interact with ridable and test result. Condition is true if ridable 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).|
+|rideOn.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='rideOn.ridable'>true</parameter>
+  <condition>rideOn.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.
+===== rideOn.begin =====
+Element is riding on a ridable while previously it did not ride on a ridable.
+===== rideOn.end =====
+Element is not riding on a ridable while previously it has been riding on a ridable.
 ====== Required Behaviors ======
-This behavior requires these other behaviors:
   * [[behavior_locomotion|ECBehaviorLocomotion]]
   * [[behavior_projecttoground|ECBehaviorProjectToGround]]
@@ Line 37: / Line 121: @@
 ====== 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 ======
@@ Line 92: / Line 177: @@
   <behavior type='ECBehaviorRideOn'>
+    <!-- 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 -->
     <string name='.name'>value</string>

Drag[en]gine Wiki

User Tools

Site Tools

Differences

Page Tools