Attachables
In depth learning on Attachable Basics can be found in this course in Motive Academy.
Attachables and Attach Receivers allow you to configure objects that can attach to each other in a scene.
VR Attachable
Attachables attach to Attach Receivers. Attachables and Attach Receivers define requirements that must be met in order to successfully attach.
Attachables can be in the following states:
State Name | Description |
Attached | Object is currently attached to another object. |
Detachable | The object is attached, but can be detached. Note that objects only enter this state if “requires detach action” or “requires attach action” is true. |
Detached | Object is not attached. |
Seeking | Object is detached, but being held and currently “seeking” an attach receiver. |
Component Settings
Name | Description |
Attached Grab Settings | Attachables override the settings of the VR Grabbable. These are the VR Grabbable settings in the Attached state (see VR Grabbable.) |
Detached Grab Settings | VR Grabbable settings in the Detached state. |
Show When Attached | Detached | Detachable | Seeking | Objects to show as the attachable moves through various states. |
Colliders | Colliders to use for attach detection. Uses object colliders by default. |
Attached To | If set, defines the object that this object is initially attached to. This object by default meets the attach requirements: this object can always attach back to the initial “Attached To” object. |
Grabbable | Can set to override the Grabbable. |
Initial State | Auto - Determine the initial state automatically Attached - Initialize in the “attached” state Detachable - Initialize in the “detachable” state Detached - Initialize in the “detached” state |
Requires Detach Action | If true, this attachable requires an explicit call to |
Requires Attach Action | If true, this attachable requires an explicit call to |
Show Target Guide | If true, show a highlight copy of the object on the target. This feedback is helpful to indicate that an attachable can be attached. |
Guide Meshes | Override the default mesh when defining the target guide. This is useful if only some parts of the attachable should show up as the guide. |
Attaches To | Defines the attach requirements for Attach Receivers that this object can attach to. Receiver: If set, explicitly define a Receiver that can receive this Attachable. Type: If set, need to match the “Type” specified by the Receiver to attach. Attach Point: Optionally override the position on the attachable that joins to Receivers that match this record. |
Joint | If set, use the specified Joint for attaching. Otherwise attach the object as a child of the Attach Receiver. (See Joints). |
Events
Name | Description |
---|---|
On Attach | Object has entered Attached state. |
On Seeking | Object has entered Seeking state. |
On Detach | Object has entered Detached state. |
On Detachable | Object has entered Detachable state. |
VR Attachable Receiver
Fields
Name | Description |
Attach to Surface | If true, Attachables attach to the surface of the receiver instead of at a specific point. |
Receivers | Defines a set of requirements for an Attachable to be received by this Receiver. If an Attachable meets any of these requirements, it can attach. Attachable: If set, explicitly defines an Attachable that can attach to this Receiver. Type: If set, needs to match the “Type” specified by any Attachable attempting to attach to this receiver. Anchor: Defines the anchor that an Attachable will attach to. Max Attachments: The maximum number of Attachables that can attach to this Receiver. |
Events
Name | Description |
---|---|
On Attached | Attachable has attached to this Receiver. |
On Detached | Attachable has detached from this Receiver. |