VRChat

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    

VRC_Station

Used to allow users to sit down, often used in combination with a VRC_Trigger. Example can be found in the SDK as VRCChair.

This component can also be used on avatars to create seats on avatars!

Parameter
Description

Player Mobility

Should the player be able to move, options include:
Mobile - Allow users to move when seated in station
Immobilize - Prevents user from moving
Immobilize For Vehicle - Same as Immobilized but optimized for moving stations

Can Use Station From Station

If the user can switch stations when sitting in a station

Animation Controller (optional)

Used to override normal seating animations with a custom one

Disable Station Exit

If the user cannot exit the station by usual means, use triggers to unseat the user

Seated

Is this a station that the user should be sitting in? If true some optimizations will be done to make seated avatars look better.

Station Enter Player Location

Transform used to define where the user should be transported to when seated

Station Exit Player Location

Transform used to define where the user should be transported to when they are unseated

Controls Object

This is used for having a station where you can control an object, such as vehicles.

Triggers available when on the same game object.

Trigger
Description

OnStationEntered

When you enter the station

OnStationExited

When you exit the station

Actions available via Triggers

Action
Description

UseStation

Uses the station

ExitStation

Exits the station

VRC_Station


Suggested Edits are limited on API Reference Pages

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