User Tools

Site Tools


dragengine:modules:dragonscript:behavior_attachslot

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_attachslot [2025/03/13 17:11] dragonlorddragengine:modules:dragonscript:behavior_attachslot [2025/05/13 14:04] (current) dragonlord
Line 53: Line 53:
  
 ===== slotDetached ===== ===== slotDetached =====
 +
 +Attachable 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 ''attachSlot'' with ''attachSlot(id)''.
 +
 +===== attachSlot.update =====
 +
 +Update attach slot.
 +
 +^Parameter^Value^Description^
 +|detach|empty string, ''dispose''|Detach attachable if one is present. If value is ''dispose'' dispose of attachable after detaching it|
 +|interactElement.assign|string|Assign attached element to [[behavior_interactelement|ECBehaviorInteractElement]] with identifier matching value string. Action fails if no element is attached or interact element behavior is absent|
 +|interact|string|Interact with attachable. 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='attachSlot.set'>
 +  <parameter name='detach'>dispose</parameter>
 +</action>
 +</code>
 +
 +===== attachSlot.check =====
 +
 +Check one or more attach slot parameters. Action succeeds if all parameter value matches their respective attach slot parameter otherwise action fails. This action is typically used as first action in a sequence to run the sequence only if a attach slot parameter matches (or not).
 +
 +^Parameter^Value^Description^
 +|empty|''true'', ''false''|Attach slot is empty or not|
 +|interact.name|string|Name of interaction|
 +|interact.has|''true'', ''false''|Has attachable and interaction with name ''interaction.name'' is present|
 +|interact.query|''true'', ''false''|Interact with attachable and test result. Condition is true if attachable 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='attachSlot.check'>
 +    <parameter name='empty'>false</parameter>
 +  </action>
 +  <!-- actions here run only if attach slot is not empty, hence an attachable is present -->
 +</sequence>
 +</code>
 +
 +====== Behavior Tree Conditions ======
 +
 +This behavior adds these behavior tree conditions if behavior tree is present. If behavior has non-empty identifier replace ''attachSlot'' with ''attachSlot(id)''.
 +
 +===== attachSlot.check =====
 +
 +Check one or more attach slot parameters. Conditions returns true if all parameter value match their respective attach slot parameter. This condition is typically used to run an action or sequence of actions as long as attach slot conditions are true.
 +
 +^Parameter^Value^Description^
 +|attachSlot.empty|''true'', ''false''|Attach slot is empty or not|
 +|attachSlot.interact.name|string|Name of interaction|
 +|attachSlot.interact.has|''true'', ''false''|Has attachable and interaction with name ''interaction.name'' is present|
 +|attachSlot.interact.query|''true'', ''false''|Interact with attachable and test result. Condition is true if attachable 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).|
 +|attachSlot.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='attachSlot.empty'>false</parameter>
 +  <condition>attachSlot.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 ''attachSlot'' with ''attachSlot(id)''.
 +
 +===== attachSlot.attached =====
 +
 +Attachable has been attached to slot
 +
 +===== attachSlot.detached =====
  
 Attachable has been removed from slot. Attachable has been removed from slot.
Line 63: Line 148:
  
   * [[behavior_collider|ECBehaviorCollider]] or [[behavior_vrhand|ECBehaviorVRHand]]   * [[behavior_collider|ECBehaviorCollider]] or [[behavior_vrhand|ECBehaviorVRHand]]
 +  * [[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 107: Line 194:
     <!-- optional: use vrhand behavior with id. if not set ECBehaviorCollider is used -->     <!-- optional: use vrhand behavior with id. if not set ECBehaviorCollider is used -->
     <string name='vrHand'>right</string>     <string name='vrHand'>right</string>
 +    
 +    <!-- 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 -->
dragengine/modules/dragonscript/behavior_attachslot.1741885868.txt.gz · Last modified: 2025/03/13 17:11 by dragonlord