VRC Station
Allow users to sit down. Example can be found in the SDK as VRCChair.
This component can also be used on avatars to create seats on avatars!
This component acts a bit differently in VRCSDK2 and VRCSDK3. We support SDK2 and SDK3 stations that have animations to drive either SDK2 or SDK3-based avatars.
There is a new parameter InStation
, which can be used to indicate that an avatar has entered a station, but might not have Seated-IK enabled. The Seated
parameter is now only true if the Seated
property was checked on the station.
Stations used in Worlds
SDK2 Station with SDK2 Avatar
The Seated property is used to decide what kind of IK the occupant should get when playing the animation.
If Seated is checked, the standard seated IK is applied to SDK2 avatars. This is where the hip and lower body is locked into place, and the head/hands are tracked.
If Seated is unchecked, the SDK2 avatar plays the animation with no IK applied.
SDK2 Station with SDK3 Avatar
The animation in the station will automatically have Tracking Control applied based on the Seated property of the station.
Additionally, if Seated is checked, a Temporary Pose Space is applied to adjust the viewpoint.
SDK3 Station with SDK2/SDK3 Avatar
SDK3 stations support the AvatarVersion
parameter. It is currently only set by SDK3 avatars (where AvatarVersion
will have a value of 3
), so SDK2 avatars will remain at the default value (check for AvatarVersion < 3
).
Transitions to begin a seated animation should branch on AvatarVersion
combined with InStation
to begin the custom animation.
The SDK2 branch should apply a fixed seated pose (if Seated is enabled), or a full-body animation if Seated is not enabled.
The SDK3 branch can choose to do any combination of animations, Tracking Control changes, and Pose Space changes that are available for SDK3 avatar. However, there will be no behind-the-scenes State Behaviors applied (which does occur in SDK2 stations).
Note that since the creator decides what type of Tracking Control to apply, the Seated property on a SDK3 station does not necessarily indicate the tracking type on SDK3 avatars.
Our example Seated controllers show this branching behavior and the proper transitions and State Behavior setup for applying a seated animation.
Parameter driver State Behaviors in animators specified on stations will only be able to drive existing avatar parameters, not create new ones.
Generally speaking, using parameter drivers in station animators is not a supported use-case.
Stations used on Avatars
The default VRCChair
prefab included in the SDK can be used on avatars to let other players "sit" on you. You can use this to make your avatar into a car, a dinner table that moves around, and more! An avatar can have up to 6 stations.
When using stations on an avatar that you want to animate on or off, you need to toggle specific objects and components. The red box (in the screenshot above) needs to be enabled upon upload. If it is disabled upon upload, the station will not work!
Toggling the red box will remove any player currently sitting in the station. Toggling the green boxes will only stop new players from sitting in the station. Since this involves disabling/enabling components and objects, this must be done in the FX layer.
Keep in mind that users can disable animations with the Safety system. If an avatar station is on by default (as in, having the toggles on by default), the stations remain active, even if the wearer has used an animation to turn them off.
There are two other restrictions upon upload:
- The Entry and Exit points must not be more than 2 meters apart.
- There can be up to 6 stations on the avatar. Any more will be disabled.
Parameters and Options
Parameter | Description |
---|---|
Player Mobility | Whether players are allowed to walk around while using the station. |
- Mobile: Allows players to move when seated in the station. | |
- Immobilize: Prevents user from moving and moves them to "Station Enter Location." | |
- Immobilize For Vehicle: Same as "Immobilize" but optimized for moving stations. | |
Can Use Station From Station | Whether the players can switch stations when sitting in a station. |
Animation Controller (optional) | Overrides the "Sitting" playable layer in the avatar controller. |
Disable Station Exit | Prevents the player from exiting the station by moving or jumping. Use the ExitStation node to remove the player from the station. |
Seated | Whether the player's avatar will sit or stand when using the station. This affects the "Seated" parameter of the avatar’s playable layers. |
Station Enter Player Location | Transform that the player is be moved to when they enter the station. |
Station Exit Player Location | Transform that the player is be moved to when they exit the station. |