SDKGrab Component⚓︎

Makes the attached object Grabbable by the player. Use it with Lua SDKGrab component to register handlers for grab, release and trigger events.

Note

Make sure to put only one SDKGrab component in to your grabbable object. If your grabbable object consists of multiple children, attach SDKGrab to the root object.

When used in conjunction with MLSynchronizer, the SDKGrab will attempt to synchronize the events in inspector, however it will not synchronize the events in Lua component. It is advised to use Local events to synchronize the states of the grabbed object in Lua scripts.

Requires⚓︎

Rigidbody.

Parameters⚓︎

Name	Description
Mode	Selects how this object behaves when grabbed. In `default` mode, the object behave like a normal object in real world. When released, the object will keeps velocity and angular velocity of the hand (effectively making it possible to throw objects around). The `Kinematic` mode is very similar to the default mode except the object won't thrown after release. In the `force` mode, the object will not be actually grabbed by the hand, rather the hand applies a force to the object. This mode is use full to apply force or pressure to object with hinges, etc.
ForceMultiplier	For the `force` mode only. Can increase or decrease (even reverse) the amount of the force applied by hand to object.
TorqueMultiplier	For the `force` mode only. Can increase or decrease (even reverse) the amount of the torque applied by hand to object.
AllowOffHandGrab	Allow this object to be grabbed by other hand.
StickToHand	Keeps object grabbed by the hand without the need to constantly pressing the grab button in controller. Press grab button again to release. (Always false in `force` mode)
GrabPoints	Grab point for the object, make sure the grab point is properly oriented and positioned, if no grab point is assigned default grab point will be created.
OnTriggerButton	Event handler, invokes when player presses the trigger button.
OnGrabBegin	Event handler, invokes when player grabs the object.
OnGrabEnd	Event handler, invokes when player releases the object.

API⚓︎

SDKGrab