Differences

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

--- dragengine:modules:dragonscript:behavior_stashable [2025/03/13 17:14] – dragonlord
+++ dragengine:modules:dragonscript:behavior_stashable [2025/05/13 14:10] (current) – dragonlord
@@ Line 62: / Line 62: @@
 Stashable has been remove from inventory.
+====== Behavior Tree Actions ======
+This behavior adds these behavior tree actions if behavior tree is present.
+===== stashable.update =====
+Update stashable.
+^Parameter^Value^Description^
+|remove|empty string, ''dispose''|Remove stashable from inventory if located in one. If value is ''dispose'' disposes of element (even if not in an inventory) and returns BTResult.running to stop the behavior tree.|
+|interactElement.assign|string|Assign inventory element to [[behavior_interactelement|ECBehaviorInteractElement]] with identifier matching value string. Action fails if not stashed or interact element behavior is absent|
+|interact|string|Interact with inventory. 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>
+<action name='stashable.update'>
+  <parameter name='remove'>dispose</parameter>
+</action>
+</code>
+===== stashable.check =====
+Check one or more stashable parameters. Action succeeds if all parameter value matches their respective stashable parameter otherwise action fails. This action is typically used as first action in a sequence to run the sequence only if a stashable parameter matches (or not).
+^Parameter^Value^Description^
+|stashed|''true'', ''false''|Stashable is located in an inventory|
+|interact.name|string|Name of interaction|
+|interact.has|''true'', ''false''|Has inventory and interaction with name ''interaction.name'' is present|
+|interact.query|''true'', ''false''|Interact with inventory and test result. Condition is true if inventory 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='stashable.check'>
+    <parameter name='stashed'>true</parameter>
+  </action>
+  <!-- actions here run only if stashable is located in an inventory -->
+</sequence>
+</code>
+====== Behavior Tree Conditions ======
+This behavior adds these behavior tree conditions if behavior tree is present.
+===== stashable.check =====
+Check one or more stashable parameters. Conditions returns true if all parameter value match their respective stashable parameter. This condition is typically used to run an action or sequence of actions as long as stashable conditions are true.
+^Parameter^Value^Description^
+|stashable.stashed|''true'', ''false''|Stashable is located in an inventory|
+|stashable.interact.name|string|Name of interaction|
+|stashable.interact.has|''true'', ''false''|Has inventory and interaction with name ''interaction.name'' is present|
+|stashable.interact.query|''true'', ''false''|Interact with inventory and test result. Condition is true if inventory 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).|
+|stashable.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='stashable.stashed'>true</parameter>
+  <condition>stashable.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.
+===== stashable.added =====
+Stashable has been added to inventory.
+===== stashable.removed =====
+Stashable has been removed from slot.
 ====== Required Behaviors ======
@@ Line 69: / Line 155: @@
 ====== 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 105: / Line 192: @@
 <elementClass name='MyClass' class='GenericBehaviorElement'>
   <behavior type='ECBehaviorStashable'>
+    <!-- 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'>Cool Tool</string>

Drag[en]gine Wiki

User Tools

Site Tools

Differences

Page Tools