Pickable Objects
Introduction
The user can pick up pickable objects if the player is configured with Pickup functions on the controllers.
Setup
Pickable objects should be constructed by creating a new inherited scene from objects/pickable.tscn; however its possible to make existing RigidBody objects pickable by adding the XRToolsPickable script to them.
The following shows a pickable teacup:
Pickable objects generally consist of:
- The RidigBody (usually inherited from objects/pickable.tscn)
- The CollisionShape (usually inherited from objects/pickable.tscn)
- A mesh to render the object
- Some number of Grab Points
The pickable object has many configuration parameters, including important
ones inherited from RigidBody which must be configured appropriately:
The most important settings include:
- Picked Up Layer: Physics layer of the object when held
- Release Mode: Physics mode of the object when released
- Collision Layer: Physics layer of the object when not held
- Collision Mask: Which layers the object collides with
A common bug is to specify a Picked Up Layer which can collide with the players body. When this mistake occurs, and the player brings the picked up object close to them, the object will push the player back, but the object is held by the player, so the player will rapidly accelerate away from the held object.
A common pickup configuration is:
- Picked Up Layer: Leave blank so the held object does not collide with anything.
- Release Mode: Original - restoring the object to the same state it had before pickup.
- Collision Layer: A standard layer for dynamic objects in the scene.
- Collision Mask: Layers for the world and other objects (so it doesn’t fall through the floor), and also matching the Pickup collision mask so it can be picked up.
See Physics Layers for recommendations on how to configure physics layers for Godot XR Tools.
Configuration
XRToolsPickable
| Property | Description |
|---|---|
| Enabled | If true, the object can be picked up |
| Press To Hold | If true, the user must hold down the grab button specified in the pickup |
| Picked Up Layer | Physics layer of the object while being held |
| Release Mode | Mode to set when the object is released |
| Ranged Grab Method | Method used for ranged-grabbing of the object |
| Second Hand Grab | How a second hand grab affects the pickable object |
| Ranged Grab Speed | Speed to perform ranged-grabbing |
| Picked By Exclude | Optional name of a group this object refuses to be picked up by |
| Picked By Require | Optional name of a group this object requires being picked up by |
| Collision Layer | Physics layers this object exists on when not held |
| Collision Mask | Physics layers this object collides with |
Note: Disabling pickup functionality via the Enabled property of an XRToolsPickable only affects whether it can be picked up. The object will still interact with the world by the rules of the RigidBody3D settings.
Additional Resources
The following videos show the creation of a basic XR Player with hands and picking up objects: