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

Interactable

<aside> <img src="/icons/warning_yellow.svg" alt="/icons/warning_yellow.svg" width="40px" /> This is an experimental component, It is likely to receive large changes in the future!

</aside>

<aside> <img src="/icons/link_blue.svg" alt="/icons/link_blue.svg" width="40px" /> Visual Scripting Implementation

</aside>

<aside> <img src="/icons/book_gray.svg" alt="/icons/book_gray.svg" width="40px" /> Creates a visual element that users can interact with based on proximity. Users can either with a tap/click on the prompt, or by using the action button (F on Web).

</aside>

Interactables

Interactables

Properties

Property Function
Interact Text Text to display on interaction
Icon Icon to show next to the interaction dialog.
Radius Radius to enable interaction
On Interact Event Event that gets invoked when the user presses the interaction button or via hotkey (F on Web).
On Enter Event Event that gets invoked when local avatar enters the interaction radius.
On Exit Event Event that gets invoked when local avatar exits the interaction radius.

Untitled

← Previous

Avatar Teleporter

Next →

Point of Interest