{{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**
</WRAP>

  * [[behaviors_use_cases|Behaviors Explained: By Use-Case]]
  * [[behaviors_a_to_z|Behaviors Explained: From A to Z]]

====== ECBehaviorGrabber ======

Behavior adding support to grab an [[behavior_grabspot|ECBehaviorGrabSpot]].

Grab spots are typically used for physics interaction like VR hand use but can be used also with mouse interaction. The actual grabbing interaction, exact grab location and orientation as well as attaching logic is handled by other behaviors using listening. This behavior also tracks if what grab spot an actor is grabbing. Hence at most one grab spot can be grabbed by this behavior at each time.

Elements able to be grabbed have to use the [[behavior_grabspot|ECBehaviorGrabSpot]] behavior. Both the grab spot and the grabber have to persist the other behavior. During restoring no notifications are triggered this way.

To detect grab spots a touch sensor is added with a default sphere shape. By default the touch sensor is disabled and has to be enabled if the game logic allows grabbing. The collision filter category is set to BaseGameApp.CollisionFilterBit.trigger and the collision filter mask is set to BaseGameApp.CollisionFilterBit.dynamic.
====== Instance Counts ======

This behavior can be added multiple times to an element. Use the behavior identifier to tell them apart.

====== Element Class Properties ======

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"
  * Type: string (shape list encoding)
  * 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 =====
Attach position relative to parent element or bone.
  * Full name: "grabber.attach.position" or "grabber(id).attach.position"
  * Type: 3-component vector
  * Default Value: (0, 0, 0)
  * Example (*.deeclass): <code xml><vector name='grabber(right).attach.position' x='0' y='0' z='0.1'/></code>

===== attach.rotation =====
Attach orientation in euler degrees relative to parent element or bone.
  * Full name: "grabber.attach.rotation" or "grabber(id).attach.rotation"
  * Type: 3-component vector
  * Default Value: (0, 0, 0)
  * Example (*.deeclass): <code xml><vector name='grabber(right).attach.rotation' x='-45' y='0' z='0'/></code>

===== attach.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"
  * Type: string
  * Default Value: empty string
  * Example (*.deeclass): <code xml><string name='grabber(right).attach.bone'>attach hand.r</string></code>

====== Required Behaviors ======

This behavior does require other behaviors.

====== Optional Behaviors ======

  * [[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

====== Persistency ======

Saves these parameters:
  * Enabled
  * [[behavior_grabspot|ECBehaviorGrabSpot]]

====== API Documentation ======

#@LinkApiDocDEDS2_HTML~classDragengine_1_1Scenery_1_1ECBehaviorGrabber.html,ECBehaviorGrabber~@#.

Since DragonScript Module Version **1.9**

====== Use Cases ======

  * Grab objects in VR

====== Element Class Example ======

The following example creates an element class with support to test what element the player is pointing at:

<code>
class MyElement extends BehaviorElementClass
   public var ECBehaviorVRPlayspace vrPlayspace
   public var ECBehaviorVRHand vrHandRight
   public var ECBehaviorVRHand vrHandLeft
   public var ECBehaviorGrabber vrRightHandGrabber
   public var ECBehaviorGrabber vrLeftHandGrabber
   
   public func new()
      // Create playspace
      vrPlayspace = ECBehaviorVRPlayspace.new(this)
      
      // Create hand controllers. The InputDeviceType indicates what device type
      // to monitor. vrRightHand and vrLeftHand can exist only once
      vrHandRight = ECBehaviorVRHand.new(this, vrPlayspace, InputDeviceType.vrRightHand, "right")
      vrHandLeft = ECBehaviorVRHand.new(this, vrPlayspace, InputDeviceType.vrLeftHand, "left")
      
      // Create grabbers for each hand
      vrRightHandGrabber = ECBehaviorGrabber.new(this, vrRightHand, "right")
      vrLeftHandGrabber = ECBehaviorGrabber.new(this, vrLeftHand, "left")
  end
end
</code>

The #@LinkApiDocDEDS2_HTML~classDragengine_1_1Scenery_1_1BaseVRActorClass.html,BaseVRActorClass~@# provides full VR support including ECBehaviorGrabber for both hands.

====== Live Examples ======

  * [[https://github.com/LordOfDragons/deexamples|DEExamples Repository]]: ExampleVR project.