Drag[en]gine Wiki

User Tools

Site Tools

Trace:
dragengine:modules:dragonscript:behavior_attachable

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_attachable [2025/03/12 19:40] – [Required Behaviors] dragonlorddragengine:modules:dragonscript:behavior_attachable [2025/05/13 14:03] (current) – 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]] >> **ECBehaviorAttachable**+[[: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]] >> **ECBehaviorAttachable**
 </WRAP> </WRAP>
  
Line 32: Line 32:
  
 ===== attachableDetached ===== ===== attachableDetached =====
 +
 +Attachable has been removed from slot.
 +
 +====== Behavior Tree Actions ======
 +
 +This behavior adds these behavior tree actions if behavior tree is present.
 +
 +===== attachable.update =====
 +
 +Update attachable.
 +
 +^Parameter^Value^Description^
 +|detach|empty string, ''dispose''|Detach element from attach slot if attached to an attach slot. If value is ''dispose'' disposed after detaching (even if not attached before) and returns BTResult.running to stop the behavior tree.|
 +|interactElement.assign|string|Assign attach slot element to [[behavior_interactelement|ECBehaviorInteractElement]] with identifier matching value string. Action fails if not attached to an attach slot or interact element behavior is absent|
 +|interact|string|Interact with attach slot. 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='attachable.update'>
 +  <parameter name='detach'>dispose</parameter>
 +</action>
 +</code>
 +
 +===== attachable.check =====
 +
 +Check one or more attachable parameters. Action succeeds if all parameter value matches their respective attachable parameter otherwise action fails. This action is typically used as first action in a sequence to run the sequence only if a attachable parameter matches (or not).
 +
 +^Parameter^Value^Description^
 +|attached|''true'', ''false''|Element is attached to an attach slot or not|
 +|interact.name|string|Name of interaction|
 +|interact.has|''true'', ''false''|Has attach slot and interaction with name ''interaction.name'' is present|
 +|interact.query|''true'', ''false''|Interact with attach slot and test result. Condition is true if attach slot 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='attachable.check'>
 +    <parameter name='attached'>true</parameter>
 +  </action>
 +  <!-- actions here run only if element is attached to a slot -->
 +</sequence>
 +</code>
 +
 +====== Behavior Tree Conditions ======
 +
 +This behavior adds these behavior tree conditions if behavior tree is present. If behavior has non-empty identifier replace ''attachable'' with ''attachable(id)''.
 +
 +===== attachable.check =====
 +
 +Check one or more attachable parameters. Conditions returns true if all parameter value match their respective attachable parameter. This condition is typically used to run an action or sequence of actions as long as attachable conditions are true.
 +
 +^Parameter^Value^Description^
 +|attachable.attached|''true'', ''false''|Element is attached to an attach slot or not|
 +|attachable.interact.name|string|Name of interaction|
 +|attachable.interact.has|''true'', ''false''|Has attach slot and interaction with name ''interaction.name'' is present|
 +|attachable.interact.query|''true'', ''false''|Interact with attach slot and test result. Condition is true if attach slot 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).|
 +|attachable.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='attachable.attached'>true</parameter>
 +  <condition>attachable.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.
 +
 +===== attachable.attached =====
 +
 +Attachable has been attached to slot.
 +
 +===== attachable.detached =====
  
 Attachable has been removed from slot. Attachable has been removed from slot.
Line 41: Line 127:
 ====== 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 84: Line 171:
      
   <behavior type='ECBehaviorAttachable'>   <behavior type='ECBehaviorAttachable'>
 +    <!-- 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_attachable.1741808441.txt.gz · Last modified: 2025/03/12 19:40 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