The VRChat Documentation Hub

Welcome to the VRChat Documentation hub. You'll find comprehensive guides and documentation to help you start working with VRChat as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    


Used to allow objects to be picked up and held


  • Rigidbody
  • Collider

Disallow Theft

If other users are allowed to take the pickup out of some else's grip

Physical Root

Can be used if the root of the object is not on the same gameobject as this script, allows for multiple pickup points on a single object.

Exact Gun

The position object will be held if set to Exact Gun

Exact Grip

The position object will be held if set to Exact Grip

Allow Manipulation When Equipped

Should the user be able to manipulate the pickup while the pickup is held if using a controller


What way the object will be held

Auto Hold

Should the pickup remain in the users hand after they let go of the grab button.
Auto Detect - Automatically detects what to do
Yes - After the grab button is released the pickup remains in the hand until the drop button is pressed and released
No - After the grab button is released the pickup is let go

Use Text

Text that appears when the user has an object equipped, prompting them to "fire" the object.
Requires "Auto Hold" to be set to "Yes".

Throw Velocity Boost Min Speed

How fast the object needs to move to be thrown

Throw Velocity Boost Scale

How much throwing should scale, higher = faster thrown while lower means slower throw speed


Can you pickup the pickup

RPC's are available via the SendRPC action

Valid Targets


Local, Owner

If the pickup is currently held, this forces it to be dropped



Plays haptic feedback on the player's controller

Updated 3 months ago


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.