User Tools

Site Tools


dragengine:modules:dragonscript:behavior_inventory

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_inventory [2025/03/13 17:14] dragonlorddragengine:modules:dragonscript:behavior_inventory [2025/05/04 13:48] (current) – [inventory.check] dragonlord
Line 27: Line 27:
 Stashable has been added to inventory. Stashable has been added to inventory.
  
-===== stashableRemoved ( Instance instance, ECBehaviorStashable.Instance stashable )+===== stashableRemoved ===== 
 + 
 +Stashable has been removed from slot. 
 + 
 +====== Behavior Tree Actions ====== 
 + 
 +This behavior adds these behavior tree actions if behavior tree is present. If behavior has non-empty identifier replace ''inventory'' with ''inventory(id)''. 
 + 
 +===== inventory.check ===== 
 + 
 +Check one or more inventory parameters. Action succeeds if all parameter value matches their respective inventory parameter otherwise action fails. This action is typically used as first action in a sequence to run the sequence only if a inventory parameter matches (or not)
 + 
 +^Parameter^Value^Description^ 
 +|count|integer|Count of stashables equals integer value| 
 +|count.not|integer|Count of stashables does not equal integer value| 
 +|count.less|integer|Count of stashables is less than integer value| 
 +|count.greater|integer|Count of stashables is greater than integer value| 
 +|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='inventory.check'> 
 +    <parameter name='count.less'>3</parameter> 
 +  </action> 
 +  <!-- actions here run only if inventory has less than 3 stashables --> 
 +</sequence> 
 +</code> 
 + 
 +====== Behavior Tree Conditions ====== 
 + 
 +This behavior adds these behavior tree conditions if behavior tree is present. If behavior has non-empty identifier replace ''inventory'' with ''inventory(id)''
 + 
 +===== inventory.check ===== 
 + 
 +Check one or more inventory parameters. Conditions returns true if all parameter value match their respective inventory parameter. This condition is typically used to run an action or sequence of actions as long as inventory conditions are true. 
 + 
 +^Parameter^Value^Description^ 
 +|inventory.count|integer|Count of stashables equals integer value| 
 +|inventory.count.not|integer|Count of stashables does not equal integer value| 
 +|inventory.count.less|integer|Count of stashables is less than integer value| 
 +|inventory.count.greater|integer|Count of stashables is greater than integer value| 
 + 
 +This is an example of using this condition: 
 +<code xml> 
 +<action name='myAction' id='doing something'> 
 +  <parameter name='inventory.count.less'>3</parameter> 
 +  <condition>inventory.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. If behavior has non-empty identifier replace ''inventory'' with ''inventory(id)''
 + 
 +===== inventory.added ===== 
 + 
 +Stashable has been added to inventory. 
 + 
 +===== inventory.removed =====
  
 Stashable has been removed from slot. Stashable has been removed from slot.
Line 37: Line 104:
 ====== 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 80: Line 148:
      
   <behavior type='ECBehaviorInventory'>   <behavior type='ECBehaviorInventory'>
 +    <!-- 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'>value</string>     <string name='.name'>value</string>
dragengine/modules/dragonscript/behavior_inventory.1741886060.txt.gz · Last modified: 2025/03/13 17:14 by dragonlord