Drag[en]gine Wiki

User Tools

Site Tools

Trace: • behavior_vrhand
dragengine:modules:dragonscript:behavior_attachslot

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_attachslot [2025/03/12 15:14] – created dragonlorddragengine:modules:dragonscript:behavior_attachslot [2025/05/04 13:46] (current) – [attachSlot.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]] >> **ECBehaviorAttachSlot**+[[: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]] >> **ECBehaviorAttachSlot**
 </WRAP> </WRAP>
  
Line 12: Line 12:
  
 Provides an attachment slot where one [[behavior_attachable|ECBehaviorAttachable]] supporting element can be attached to. The slot behavior is responsible to persist the UniqueID of the attachable. Attachable is added to game world during addToGameWorld() if not in the game world already. Attachable is remove from game world during removeFromGameWorld() if in the game world. If attachable is present while behavior instance is disposed then attachable will be safely disposed using Element.safeDispose() . Provides an attachment slot where one [[behavior_attachable|ECBehaviorAttachable]] supporting element can be attached to. The slot behavior is responsible to persist the UniqueID of the attachable. Attachable is added to game world during addToGameWorld() if not in the game world already. Attachable is remove from game world during removeFromGameWorld() if in the game world. If attachable is present while behavior instance is disposed then attachable will be safely disposed using Element.safeDispose() .
 +
 +Behavior supports using [[behavior_vrhand|ECBehaviorVRHand]] instead of [[behavior_collider|ECBehaviorCollider]] to add attachment slot to VR hands.
  
 ====== Instance Counts ====== ====== Instance Counts ======
Line 51: 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.detach =====
 +
 +Detach attachable if one is present.
 +
 +^Parameter^Value^Description^
 +|dispose| |Dispose of attachable after detaching it|
 +
 +This is an example of using this action:
 +<code xml>
 +<action name='attachSlot.detach'>
 +  <parameter name='dispose'/>
 +</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|
 +|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|
 +
 +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 60: Line 136:
 ====== Optional Behaviors ====== ====== Optional Behaviors ======
  
-This behavior does support these optional behaviors: 
   * [[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 106: Line 183:
     <!-- 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.1741792476.txt.gz · Last modified: 2025/03/12 15:14 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