Skip to content

Untitled Sandbox - Developer Documentation

Guides API Types

Guides API Types

Players and NPCs

Player Target Team Npc Movement

Instances

Instance TagSet Bounds Face Seat Spawn Clickable InteractPrompt

Billboard SurfaceText SurfaceTextOptions Font Constraint CloneOptions

Spawning and queries

SpawnOptions PrefabSpawnOptions PrefabInfo QueryFilter RaycastHit Overlap

Motion and lighting

Tween TweenOptions Lighting LightingTweenOptions Color

Screens

Screen UiElement UiTransition UiScreen PopupOptions PopupAnswer Countdown Progress

Camera and cutscenes

CameraMove Sequence SequenceDefinition SequenceTrack SequenceKey SequenceMarker

Events

Event Connection ConnectOptions

Game logic

State PlayerState InstanceState LeaderboardOptions Signal Schema RandomGenerator DateParts

Saving and the web

Document DocumentCollection SchemaOptions KeyValueStore OrderedStore OrderedEntry HttpRequest HttpResponse

Testing

Expectation TestOptions

docs/types/InteractPrompt

InteractPrompt

A prompt that players see near an instance and can trigger with a key, which you show by setting Instance.prompt.

Fields

textstring

distancenumber?

holdnumber?

↑ ↓ moveEnter openEsc close