Drag[en]gine Wiki

User Tools

Site Tools

Trace: • newproject
dragengine:modules:dragonscript:behavior_stashable

Differences

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

Link to this comparison view

Next revision		Previous revision
dragengine:modules:dragonscript:behavior_stashable [2025/03/12 21:44] – created dragonlorddragengine:modules:dragonscript:behavior_stashable [2025/05/04 13:48] (current) – [stashable.check] dragonlord
Line 1: Line 1:
 {{tag>dragonscript behavior}} {{tag>dragonscript behavior}}
 <WRAP youarehere> <WRAP youarehere>
-[[:start|Start Page]] >> [[main|DragonScript Scripting Language]] >> [[abstractions#behavior_elementsquick_and_easy_development|Behavior Elements: Quick and Easy Development]] >> **ECBehaviorStashable**+[[: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]] >> **ECBehaviorStashable**
 </WRAP> </WRAP>
  
Line 62: Line 62:
  
 Stashable has been remove from inventory. Stashable has been remove from inventory.
 +
 +====== Behavior Tree Actions ======
 +
 +This behavior adds these behavior tree actions if behavior tree is present.
 +
 +===== stashable.remove =====
 +
 +Remove stashable from inventory if located in one.
 +
 +^Parameter^Value^Description^
 +|dispose| |If present dispose of the stashable after removing it from the inventory, no matter if present in one or not|
 +
 +This is an example of using this action:
 +<code xml>
 +<action name='stashable.remove'>
 +  <parameter name='dispose'>true</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|
 +|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|
 +
 +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 ====== ====== Required Behaviors ======
Line 69: Line 144:
 ====== 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 105: Line 181:
 <elementClass name='MyClass' class='GenericBehaviorElement'> <elementClass name='MyClass' class='GenericBehaviorElement'>
   <behavior type='ECBehaviorStashable'>   <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 -->     <!-- set element properties. omit property prefix if used inside behavior tag -->
     <string name='.name'>Cool Tool</string>     <string name='.name'>Cool Tool</string>
dragengine/modules/dragonscript/behavior_stashable.1741815849.txt.gz · Last modified: 2025/03/12 21:44 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