Advanced Features

This guide covers advanced scene features including skyboxes, spawn points, movement bounds, gamemodes, autosave, trigger volumes, and teleport volumes.

Skybox

Skyboxes provide environment mapping for the scene background.

"skybox": {
  "uri": "https://example.com/skybox.jpg",
  "rotation": {"x": 0.0, "y": 0.0, "z": 0.0}
}

Properties:

uri (string, required): URL to skybox texture
- Supports cubemap (6 faces) or equirectangular formats
- Must be HTTPS
rotation (vec3, optional): Rotation in degrees for animated skies

Use cases: Sky, space, indoor environments, atmosphere

Spawn Points

Spawn points define where players appear when entering the scene.

"spawn": {"x": 0.0, "y": 1.0, "z": 0.0}

Default: (0, 0, 0) if not specified

Use cases:

Start locations
Respawn points
Scene entry points

Movement Bounds

Movement bounds limit player movement to a specific area.

"movementBounds": {
  "min": {"x": -50.0, "y": 0.0, "z": -50.0},
  "max": {"x": 50.0, "y": 100.0, "z": 50.0}
}

Properties:

min (vec3, required): Minimum bounds (X, Y, Z)
max (vec3, required): Maximum bounds (X, Y, Z)

Default: (-100, -100, -100) to (100, 100, 100) if not specified

Use cases:

Confined spaces
Level boundaries
Preventing players from leaving the play area

Gamemode Scripts

Gamemode scripts provide scene-wide logic and state management.

"gamemode": {
  "file": "gamemode-script"
}

Properties:

file (string, required): Asset ID of the gamemode script

Features:

Scene-wide state management
Event system
Save/load support
Persistent data via localStorage

See Lua/Luau API - Gamemode for details.

Autosave Volumes

Autosave volumes automatically save game state when the player enters.

{
  "id": "autosave-zone",
  "type": "autosaveVolume",
  "position": {"x": 0.0, "y": 0.0, "z": 0.0},
  "rotation": {"x": 0.0, "y": 0.0, "z": 0.0},
  "scale": {"x": 5.0, "y": 5.0, "z": 5.0},
  "autosaveVolume": {}
}

Behavior:

Triggers when player enters the volume
Saves gamemode state and script state
Can show notification (configured via autosaveNotification)

Use cases: Checkpoints, safe zones, progress saving

Autosave Notifications

Configure on-screen notifications when autosave occurs.

"autosaveNotification": {
  "text": "Game saved!",
  "position": {"x": 0.02, "y": 0.95},
  "font": "default-font",
  "color": {"x": 1.0, "y": 1.0, "z": 1.0}
}

Properties:

text (string, optional): Notification text
position (vec2, required): Screen position (0-1 normalized)
- X: 0 = left, 1 = right
- Y: 0 = bottom, 1 = top
font (string, optional): Font asset ID
color (vec3, optional): Text color (RGB, 0-1)

Trigger Volumes

Trigger volumes detect player presence and trigger events. There are many types:

Look At Volume (`type: "lookAtVolume"`)

Triggers when player looks at the volume.

{
  "id": "look-trigger",
  "type": "lookAtVolume",
  "position": {"x": 0.0, "y": 0.0, "z": 0.0},
  "rotation": {"x": 0.0, "y": 0.0, "z": 0.0},
  "scale": {"x": 2.0, "y": 2.0, "z": 2.0},
  "lookAtVolume": {}
}

Looked At Volume (`type: "lookedAtVolume"`)

Triggers once when player has looked at it.

{
  "id": "looked-trigger",
  "type": "lookedAtVolume",
  "position": {"x": 0.0, "y": 0.0, "z": 0.0},
  "rotation": {"x": 0.0, "y": 0.0, "z": 0.0},
  "scale": {"x": 2.0, "y": 2.0, "z": 2.0},
  "lookedAtVolume": {}
}

Single Trigger Volume (`type: "singleTriggerVolume"`)

Triggers once when player enters.

{
  "id": "single-trigger",
  "type": "singleTriggerVolume",
  "position": {"x": 0.0, "y": 0.0, "z": 0.0},
  "rotation": {"x": 0.0, "y": 0.0, "z": 0.0},
  "scale": {"x": 2.0, "y": 2.0, "z": 2.0},
  "singleTriggerVolume": {}
}

Multi Trigger Volume (`type: "multiTriggerVolume"`)

Triggers every time player enters.

{
  "id": "multi-trigger",
  "type": "multiTriggerVolume",
  "position": {"x": 0.0, "y": 0.0, "z": 0.0},
  "rotation": {"x": 0.0, "y": 0.0, "z": 0.0},
  "scale": {"x": 2.0, "y": 2.0, "z": 2.0},
  "multiTriggerVolume": {}
}

Cooldown Trigger Volume (`type: "cooldownTriggerVolume"`)

Triggers with a cooldown period.

{
  "id": "cooldown-trigger",
  "type": "cooldownTriggerVolume",
  "position": {"x": 0.0, "y": 0.0, "z": 0.0},
  "rotation": {"x": 0.0, "y": 0.0, "z": 0.0},
  "scale": {"x": 2.0, "y": 2.0, "z": 2.0},
  "cooldownTriggerVolume": {
    "cooldown": 5.0
  }
}

Properties:

cooldown (number): Cooldown time in seconds

Exit Trigger Volume (`type: "exitTriggerVolume"`)

Triggers when player exits the volume.

{
  "id": "exit-trigger",
  "type": "exitTriggerVolume",
  "position": {"x": 0.0, "y": 0.0, "z": 0.0},
  "rotation": {"x": 0.0, "y": 0.0, "z": 0.0},
  "scale": {"x": 2.0, "y": 2.0, "z": 2.0},
  "exitTriggerVolume": {}
}

Stay Trigger Volume (`type: "stayTriggerVolume"`)

Triggers continuously while player stays in volume.

{
  "id": "stay-trigger",
  "type": "stayTriggerVolume",
  "position": {"x": 0.0, "y": 0.0, "z": 0.0},
  "rotation": {"x": 0.0, "y": 0.0, "z": 0.0},
  "scale": {"x": 2.0, "y": 2.0, "z": 2.0},
  "stayTriggerVolume": {
    "interval": 1.0
  }
}

Properties:

interval (number, optional): Trigger interval in seconds

Timed Entry Trigger Volume (`type: "timedEntryTriggerVolume"`)

Triggers after player has been in volume for a duration.

{
  "id": "timed-trigger",
  "type": "timedEntryTriggerVolume",
  "position": {"x": 0.0, "y": 0.0, "z": 0.0},
  "rotation": {"x": 0.0, "y": 0.0, "z": 0.0},
  "scale": {"x": 2.0, "y": 2.0, "z": 2.0},
  "timedEntryTriggerVolume": {
    "duration": 3.0
  }
}

Properties:

duration (number): Required stay duration in seconds

Counter Trigger Volume (`type: "counterTriggerVolume"`)

Triggers after player enters a certain number of times.

{
  "id": "counter-trigger",
  "type": "counterTriggerVolume",
  "position": {"x": 0.0, "y": 0.0, "z": 0.0},
  "rotation": {"x": 0.0, "y": 0.0, "z": 0.0},
  "scale": {"x": 2.0, "y": 2.0, "z": 2.0},
  "counterTriggerVolume": {
    "count": 5
  }
}

Properties:

count (number): Required entry count

Sequence Trigger Volume (`type: "sequenceTriggerVolume"`)

Triggers in a sequence pattern.

{
  "id": "sequence-trigger",
  "type": "sequenceTriggerVolume",
  "position": {"x": 0.0, "y": 0.0, "z": 0.0},
  "rotation": {"x": 0.0, "y": 0.0, "z": 0.0},
  "scale": {"x": 2.0, "y": 2.0, "z": 2.0},
  "sequenceTriggerVolume": {
    "sequence": [1, 2, 3]
  }
}

Properties:

sequence (array): Sequence pattern

Toggle Trigger Volume (`type: "toggleTriggerVolume"`)

Toggles on/off each time player enters.

{
  "id": "toggle-trigger",
  "type": "toggleTriggerVolume",
  "position": {"x": 0.0, "y": 0.0, "z": 0.0},
  "rotation": {"x": 0.0, "y": 0.0, "z": 0.0},
  "scale": {"x": 2.0, "y": 2.0, "z": 2.0},
  "toggleTriggerVolume": {}
}

Teleport Volumes

Teleport volumes instantly move the player to a new position.

{
  "id": "teleporter",
  "type": "teleportVolume",
  "position": {"x": 0.0, "y": 0.0, "z": 0.0},
  "rotation": {"x": 0.0, "y": 0.0, "z": 0.0},
  "scale": {"x": 2.0, "y": 2.0, "z": 2.0},
  "teleportVolume": {
    "destination": {"x": 10.0, "y": 5.0, "z": 10.0}
  }
}

Properties:

destination (vec3, required): Target position

Use cases: Elevators, fast travel, level transitions

Interaction Volumes

Interaction volumes provide custom interaction zones.

{
  "id": "interaction-zone",
  "type": "interactionVolume",
  "position": {"x": 0.0, "y": 0.0, "z": 0.0},
  "rotation": {"x": 0.0, "y": 0.0, "z": 0.0},
  "scale": {"x": 2.0, "y": 2.0, "z": 2.0},
  "interactionVolume": {}
}

Volume Size

All volumes use the scale property to define their size:

Scale X: Width
Scale Y: Height
Scale Z: Depth

The volume is a box centered at the position, with dimensions determined by scale.

Trigger Events

Trigger volumes fire events that can be handled by:

Gamemode scripts via Gamemode.onEvent()
Entity scripts via event listeners
Engine systems

Event names follow the pattern: volume_<type>_<instanceId>

Best Practices

Size volumes appropriately: Not too small (hard to trigger) or too large (triggers unexpectedly)
Use appropriate trigger types: Choose the right volume type for your use case
Test trigger behavior: Verify volumes work as expected
Combine with scripts: Use volumes to trigger script behaviors
Organize with worlds: Use world IDs to group related scenes

Next Steps

Lua/Luau API - Learn to script volume behaviors
Examples - See advanced features in action
Scene Format Intro - Return to scene format overview

Skybox​

Spawn Points​

Movement Bounds​

Gamemode Scripts​

Autosave Volumes​

Autosave Notifications​

Trigger Volumes​

Look At Volume (type: "lookAtVolume")​

Looked At Volume (type: "lookedAtVolume")​

Single Trigger Volume (type: "singleTriggerVolume")​

Multi Trigger Volume (type: "multiTriggerVolume")​

Cooldown Trigger Volume (type: "cooldownTriggerVolume")​

Exit Trigger Volume (type: "exitTriggerVolume")​

Stay Trigger Volume (type: "stayTriggerVolume")​

Timed Entry Trigger Volume (type: "timedEntryTriggerVolume")​

Counter Trigger Volume (type: "counterTriggerVolume")​

Sequence Trigger Volume (type: "sequenceTriggerVolume")​

Toggle Trigger Volume (type: "toggleTriggerVolume")​

Teleport Volumes​

Interaction Volumes​

Volume Size​

Trigger Events​

Best Practices​

Next Steps​

Skybox

Spawn Points

Movement Bounds

Gamemode Scripts

Autosave Volumes

Autosave Notifications

Trigger Volumes

Look At Volume (`type: "lookAtVolume"`)

Looked At Volume (`type: "lookedAtVolume"`)

Single Trigger Volume (`type: "singleTriggerVolume"`)

Multi Trigger Volume (`type: "multiTriggerVolume"`)

Cooldown Trigger Volume (`type: "cooldownTriggerVolume"`)

Exit Trigger Volume (`type: "exitTriggerVolume"`)

Stay Trigger Volume (`type: "stayTriggerVolume"`)

Timed Entry Trigger Volume (`type: "timedEntryTriggerVolume"`)

Counter Trigger Volume (`type: "counterTriggerVolume"`)

Sequence Trigger Volume (`type: "sequenceTriggerVolume"`)

Toggle Trigger Volume (`type: "toggleTriggerVolume"`)

Teleport Volumes

Interaction Volumes

Volume Size

Trigger Events

Best Practices

Next Steps