Differences

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

--- dragengine:modules:dragonscript:behavior_grabber [2024/03/14 16:51] – dragonlord
+++ dragengine:modules:dragonscript:behavior_grabber [2025/05/13 14:05] (current) – dragonlord
@@ Line 1: / Line 1: @@
 {{tag>dragonscript behavior}}
 <WRAP youarehere>
-[[:start|Start Page]] >> [[main|DragonScript Scripting Language]] >> [[abstractions#behavior_elementsquick_and_easy_development|Behavior Elements: Quick and Easy Development]] >> **ECBehaviorGrabber**
+[[: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]] >> **ECBehaviorGrabber**
 </WRAP>
@@ Line 22: / Line 22: @@
 ====== Element Class Properties ======
-Element class properties have the prefix **grabber.** or **grabber(id).** if id is not empty.
+Element class properties have the prefix ''grabber.'' or ''grabber(id).'' if id is not empty.
 ===== shape =====
 Shape of collider used to detect grab spots.
-  * Full name: "grabber.shape" or "grabber(id).shape"
+  * Full name: ''grabber.shape'' or ''grabber(id).shape''
-  * Type: string (shape list encoding)
+  * Type: string (shape format). See "Shape List Encoding" in CodecPropertyString.
   * Default Value: empty string
   * Example (*.deeclass): <code xml><string name='grabber(right).shape'>box:extends,0.1,0.1,0.1</string></code>
-===== attach.position =====
+===== position =====
 Attach position relative to parent element or bone.
-  * Full name: "grabber.attach.position" or "grabber(id).attach.position"
+  * Full name: ''grabber.position'' or ''grabber(id).position''
-  * Type: 3-component vector
+  * Type: 3-component float vector
-  * Default Value: (0, 0, 0)
+  * Default Value: ''(0, 0, 0)''
-  * Example (*.deeclass): <code xml><vector name='grabber(right).attach.position' x='0' y='0' z='0.1'/></code>
+  * Example (*.deeclass): <code xml><vector name='grabber(right).position' x='0' y='0' z='0.1'/></code>
-===== attach.rotation =====
+===== rotation =====
 Attach orientation in euler degrees relative to parent element or bone.
-  * Full name: "grabber.attach.rotation" or "grabber(id).attach.rotation"
+  * Full name: ''grabber.rotation'' or ''grabber(id).rotation''
-  * Type: 3-component vector
+  * Type: 3-component float vector
-  * Default Value: (0, 0, 0)
+  * Default Value: ''(0, 0, 0)''
-  * Example (*.deeclass): <code xml><vector name='grabber(right).attach.rotation' x='-45' y='0' z='0'/></code>
+  * Example (*.deeclass): <code xml><vector name='grabber(right).rotation' x='-45' y='0' z='0'/></code>
-===== attach.bone =====
+===== bone =====
 Name of bone to attach to or empty string to attach to the parent element.
-  * Full name: "grabber.attach.bone" or "grabber(id).attach.bone"
+  * Full name: ''grabber.bone'' or ''grabber(id).bone''
   * Type: string
   * Default Value: empty string
-  * Example (*.deeclass): <code xml><string name='grabber(right).attach.bone'>attach hand.r</string></code>
+  * Example (*.deeclass): <code xml><string name='grabber(right).bone'>attach hand.r</string></code>
+====== Events ======
+===== spotGrabbed =====
+Grabber grabbed grab spot.
+===== spotReleased =====
+Grabber released grab spot.
+===== touchGrabSpot =====
+Start touching grab spot.
+===== untouchGrabSpot =====
+Stop touching grab spot.
+===== canTouchGrabSpot =====
+Grab spot can be touched if all listeners return true.
+===== enabledChanged =====
+Grabber enabled changed.
+====== Behavior Tree Actions ======
+This behavior adds these behavior tree actions if behavior tree is present. If behavior has non-empty identifier replace ''grabber'' with ''grabber(id)''.
+===== grabber.set =====
+Set one or more grabber parameters.
+^Parameter^Value^Description^
+|enabled|''true'', ''false''|Grabber is enabled|
+This is an example of using this action:
+<code xml>
+<action name='grabber.set'>
+  <parameter name='enabled'>true</parameter>
+</action>
+</code>
+===== grabber.update =====
+Update grabber.
+^Parameter^Value^Description^
+|release| |Release grab spot if grabbing one.|
+|interactElement.assign|string|Assign grab spot element to [[behavior_interactelement|ECBehaviorInteractElement]] with identifier matching value string. Action fails if no element is grabbed or interact element behavior is absent|
+|interact|string|Interact with grab spot. 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='grabber.update'>
+  <parameter name='release'/>
+</action>
+</code>
+===== grabber.check =====
+Check one or more grabber parameters. Action succeeds if all parameter value matches their respective grabber parameter otherwise action fails. This action is typically used as first action in a sequence to run the sequence only if a grabber parameter matches (or not).
+^Parameter^Value^Description^
+|enabled|''true'', ''false''|Grabber is enabled|
+|grabbing|''true'', ''false''|Grabber is grabbing a grab spot|
+|interact.name|string|Name of interaction|
+|interact.has|''true'', ''false''|Has grab spot and interaction with name ''interaction.name'' is present|
+|interact.query|''true'', ''false''|Interact with grab spot and test result. Condition is true if grab spot 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='grabber.check'>
+    <parameter name='grabbing'>true</parameter>
+  </action>
+  <!-- actions here run only if grabber is grabbing a grab spot -->
+</sequence>
+</code>
+====== Behavior Tree Conditions ======
+This behavior adds these behavior tree conditions if behavior tree is present. If behavior has non-empty identifier replace ''grabber'' with ''grabber(id)''.
+===== grabber.check =====
+Check one or more grabber parameters. Conditions returns true if all parameter value match their respective grabber parameter. This condition is typically used to run an action or sequence of actions as long as grabber conditions are true.
+^Parameter^Value^Description^
+|grabber.enabled|''true'', ''false''|Grabber is enabled|
+|grabber.grabbing|''true'', ''false''|Grabber is grabbing a grab spot|
+|grabber.interact.name|string|Name of interaction|
+|grabber.interact.has|''true'', ''false''|Has grab spot and interaction with name ''interaction.name'' is present|
+|grabber.interact.query|''true'', ''false''|Interact with grab spot and test result. Condition is true if grab spot 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).|
+|grabber.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='grabber.grabbing'>true</parameter>
+  <condition>grabber.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 ''grabber'' with ''grabber(id)''.
+===== grabber.enabled =====
+Grabber has been enabled.
+===== grabber.disabled =====
+Grabber has been disabled.
+===== grabber.grabbed =====
+Grabber grabbed grab spot.
+===== grabber.released =====
+Grabber released grab spot.
+===== grabber.touch =====
+Start touching grab spot.
+===== grabber.untouch =====
+Stop touching grab spot.
 ====== Required Behaviors ======
@@ Line 60: / Line 204: @@
   * [[behavior_collider|ECBehaviorCollider]]: If used attaches grab spot touch collider to collider
   * [[behavior_vrhand|ECBehaviorVRHand]]: If used attaches grab spot touch collider to VR hand collider
+  * [[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 ======
-Saves these parameters:
+This behavior does support element class to be persistable (setPersistable).
-  * Enabled
-  * [[behavior_grabspot|ECBehaviorGrabSpot]]
 ====== API Documentation ======
@@ Line 71: / Line 215: @@
 #@LinkApiDocDEDS2_HTML~classDragengine_1_1Scenery_1_1ECBehaviorGrabber.html,ECBehaviorGrabber~@#.
-Since DragonScript Module Version **1.9**
+Since DragonScript Module Version ''1.9''
 ====== Use Cases ======
@@ Line 106: / Line 250: @@
 The #@LinkApiDocDEDS2_HTML~classDragengine_1_1Scenery_1_1BaseVRActorClass.html,BaseVRActorClass~@# provides full VR support including ECBehaviorGrabber for both hands.
+====== Behavior Factory ======
+Using element class supporting adding behaviors the behavior can be added like this:
+<code xml>
+<?xml version='1.0' encoding='UTF-8'?>
+<elementClass name='MyClass' class='GenericBehaviorElement'>
+  <behavior type='ECBehaviorVRPlayspace'/>
+  <behavior type='ECBehaviorVRHand' id='right'/>
+  <behavior type='ECBehaviorVRHand' id='left'/>
+  <behavior type='ECBehaviorGrabber' id='right'>
+    <!-- optional: use vr hand with id instead of empty string -->
+    <string name='vrHand'>right</string>
+    <!-- optional: set collision filter. default value '4:1' which means
+                   category BaseGameApp.CollisionFilterBit.trigger
+                   filter BaseGameApp.CollisionFilterBit.dynamic.
+                   format is '', 'category' or 'category:filter' where category and filter
+                   are a list of bits to set. -->
+    <string name='collisionFilter'>4:1 2</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 -->
+    <string name='.bone'>hand.r</string>
+  </behavior>
+  <!-- for adding multiple behaviors use unique identifiers -->
+  <behavior type='ECBehaviorCustomColor' id='left'>
+    <string name='vrHand'>left</string>
+    <string name='.bone'>hand.l</string>
+  </behavior>
+</elementClass>
+</code>
 ====== Live Examples ======
   * [[https://github.com/LordOfDragons/deexamples|DEExamples Repository]]: ExampleVR project.

Drag[en]gine Wiki

User Tools

Site Tools

Differences

Page Tools