Getting Started
Introduction
Installation
Project Configuration
Testing in Your Sandbox
Samples & Examples
Core Concepts & Glossary
Package Types
Spaces & Space Templates
Custom Avatars
Custom Avatar Animations
Avatar Attachments
Custom Prefab Objects
Embedded Packages
Drivable Vehicles
Scene Setup
Testing In Unity vs Sandbox
Controlling the Camera
Custom Collision, Layers, and Tags
Audio Mixers and Groups
Key Differences from Standard Unity3D development
Economy
Quests and Rewards
Economy Overview
Monetization
Items
Consumable Items
Rewarding Items
World Currency
Selling Items
Scripting
‣
‣
Components
Entrance Point
Camera Passthrough
Interactable
Trigger Event
Point Of Interest
Environment Settings Overrides
Render Pipeline Settings Overrides
Movement Materials
Climbable
Avatar Teleporter
Empty Frame
Projector Surface
Seat Hotspot
Guidelines
Supported Features and Limitations
Performance Guidelines
Lighting
Publishing to Spatial
Finding Published Packages
Support
FAQs
Help and Support
Release Notes
Asset Import Settings
Environment Settings Overrides
This component allows creators to provide their own values for common space settings such as an avatar’s run speed, default camera behavior, and more.
Properties
Property | Description |
Disable Teleport | If selected, users cannot teleport by clicking or tapping on the screen. Teleportation is disabled by default for Creator Toolkit spaces. For large “open-world” style experiences where exploration is NOT the focus, consider enabling teleportation for accessibility.
Teleportation is disabled by default for spaces made with the Creator Toolkit. |
Use Seat Hot Spots As Spawn Points | If this is true, users will be spawned to seats instead of Entrance Point.
This can be useful for auditorium or stage environments. |
Enable Avatar to Avatar Collisions | If this is true, the meshes of users’ avatars will not intersect with one another. This can be useful when creating games where limited physical space is a key factor. |
Enable Avatar Ragdolls | Allows avatars to be activated and deactivated through scripting. |
Camera Rotation Mode | Sets the default camera mode for the user, overriding their own setting.
Options:
-Auto Rotate
-Pointer Locked - Locked
-Drag to Rotate
-Pointer Locked - Unlocked |
Respawn Level Y | The Y position in world units at which physics objects such as avatars should respawn or be deleted. This can be visualized by the translucent red plane in the scene view. |
Default Movement Material | When defined all colliders without a movement material surface will use this movement material. |
Avatar Control Settings | Options:
-Default
-Override
|
Avatar Control Settings - Override
Property | Description |
Walk Speed (m/s) | Normal movement speed.
Default is 3. |
Run Speed (m/s) | Movement speed when running.
Default is 6.875. |
Jump Height (m) | Jump height in meters.
Default is 1.5 |
Gravity Multiplier | Based on the physics gravity Y value. A higher value applies more gravity.
Default is 1.5. |
Falling Gravity Multiplier | Additional gravity multiplier used when falling. Stacks with Gravity Multiplier.
Default is 1. |
Use Variable Jump Height | Jump higher depending on how long jump button is held.
Default is true. |
Maximum Jump Count | Maximum number of jumps than can be performed in succession.
Default is 2. |
Ground Friction | How much ground friction to apply to the avatar. A higher value will give the avatar more grip resulting in higher acceleration. This does not affect max speed.
Default is 1. |
Air Control | How much control the player has over the avatar while in the air.
Default is 1. |
How To Use
Add the Spatial Environment Settings Override component to any game object in the scene.
Make sure that only one of these exist in your scene.
