Description
The VRC_SceneDescriptor component is the component used to describe that the current unity scene should be uploaded to VRChat as a world. There are many settings here that are used to configure your world. You can only upload scenes with one VRC_SceneDescriptor. When adding a VRC_SceneDescriptor to a GameObject, a VRCPipelineManager will also be added.
Most information here was taken from the Official Documentation page.
Parameters
Spawns
An array of transforms used as reference for spawn points of the world.
Spawn Order
Order in which spawn locations should be used, options include:
- First - Always use the first spawn
- Sequential - In the order that spawns are listed
- Random - Spawns users in randomly
- Demo - The spawn point represents the center of your room scale meaning e.g. If you're a meter away from the center of your room scale, you spawn a meter away from the spawn
Spawn Orientation
Orientation the user will be spawned in at, options include:
- Default - The VRChat Default spawn setting (Currently Align Player With Spawn Point)
- Align Player With Spawn Point - Aligns player with the rotation of the spawn transform
- Align Room With Spawn Point - Aligns players room scale to be centered on spawn point
Reference Camera
Settings from this camera are applied to users in the room. Can be object in scene or prefab. Note that culling layers are not transferred to the player's camera. You can also attach post processing stack to the camera and it will be added to the player's camera.
Respawn Height -Y
Height in which players respawn and pickups are respawned or destroyed. The default setting is -100.
Object Behaviour At Respawn
What should pickups do when they fall out of the world, options include:
- Destroy - Delete the pickup
- Respawn - Respawn the pickup to the location it started at
Default value is Destroy.
Forbid Free Modification
If true, non-sync'd objects can't be manipulated by non-master
Forbid User Portals
Prevent users from opening portals from the world menu
User Custom Voice Falloff Range
Enabled the next couple options which control the voice falloff range. Use this instead of player mods voice falloff.
Voice Falloff Near
The distance where users voices start reducing in volume. It is recommended that you do not edit the near falloff value.
Voice Falloff Far
The distance where users voices become inaudible. It is recommended that you only edit the far falloff value when changing the voice falloff.
Unity Version
Unity version being used, you should never need to touch this.
Dynamic Prefabs
An array of prefabs that can be dynamically spawned at runtime. Any prefab that isn't referenced in the scene but needs to be spawned should be listed here. Every GameObject or prefab listed here must have a unique name to be spawned properly.
Dynamic Materials
An array of materials that can be dynamically changed at runtime. Any material that isn't referenced in scene but needs to be set to an object should be listed here. Every material listed here must have a unique name to be used properly.
Update Time in MS
How often clients should communicate with each other, this affects smoothness of user and pickup movement.
The default 33ms should be good in most cases, in worlds where you want a lot of users increase the time between updates.
Other topics
Moving Spawn
The spawn points are normal GameObjects. This means they can be moved at runtime allowing players to respawn to different locations depending on what is going on in the world. This can be achieved by adding animator and animating the spawn point location. While it is possible to delete the spawn point, it is highly not recommended.
Dynamic Prefabs
Dynamic Prefabs do not need to only include prefabs from your assets folder. You can add GameObjects in the scene into this list and spawn them by name as well. See dynamic prefabs page (link).