Type Alias: WorldOptions

WorldOptions = object

Defined in: packages/core/src/init/world-initializer.ts:96

Options for initializeWorld / World.create.

Remarks

Defaults are tuned for VR; you can override camera frustum and default lighting via WorldOptions.render.

Properties

assets?

optional assets: AssetManifest

Defined in: packages/core/src/init/world-initializer.ts:98

Asset manifest to preload before the first frame.

---

features?

optional features: object

Defined in: packages/core/src/init/world-initializer.ts:137

Opt‑in feature systems.

camera?

optional camera: boolean

Camera access for video streaming.

Default Value

false

environmentRaycast?

optional environmentRaycast: boolean

Environment Raycast (hit-test against real-world surfaces).

Default Value

false

grabbing?

optional grabbing: boolean | { useHandPinchForGrab?: boolean; }

Grabbing (one/two‑hand, distance).

Default Value

false

locomotion?

optional locomotion: boolean | { browserControls?: BrowserLocomotionControls; comfortAssistLevel?: number; enableJumping?: boolean; initialPlayerPosition?: [number, number, number]; turningMethod?: TurningMethod; useWorker?: boolean; }

Locomotion (teleport/slide/turn). Boolean or config.

Type Declaration

boolean

{ browserControls?: BrowserLocomotionControls; comfortAssistLevel?: number; enableJumping?: boolean; initialPlayerPosition?: [number, number, number]; turningMethod?: TurningMethod; useWorker?: boolean; }

Default Value

false

physics?

optional physics: boolean

Physics simulation (Havok).

Default Value

false

sceneUnderstanding?

optional sceneUnderstanding: boolean | { showWireFrame?: boolean; }

Scene Understanding (planes/meshes/anchors). Boolean or config.

Default Value

false

spatialUI?

optional spatialUI: boolean | { forwardHtmlEvents?: boolean; kits?: Record<string, unknown>[] | Record<string, unknown>; preferredColorScheme?: ColorScheme; }

Spatial UI systems (PanelUI/ScreenSpace/Follow). Boolean or config.

Type Declaration

boolean

{ forwardHtmlEvents?: boolean; kits?: Record<string, unknown>[] | Record<string, unknown>; preferredColorScheme?: ColorScheme; }

Default Value

true

---

input?

optional input: object

Defined in: packages/core/src/init/world-initializer.ts:128

Browser input and pointer interaction configuration.

canvasPointerEvents?

optional canvasPointerEvents: CanvasPointerEventsOption

Forward DOM pointer events from the renderer canvas into the Three scene.

Default Value

true

---

level?

optional level: { url?: string; } | string

Defined in: packages/core/src/init/world-initializer.ts:101

Level to load after initialization. Accepts a GLXF URL string or an object with a url field.

---

render?

optional render: object

Defined in: packages/core/src/init/world-initializer.ts:107

Renderer & camera configuration.

camera?

optional camera: object

Initial local camera pose under world.player.

camera.lookAt?

optional lookAt: [number, number, number]

camera.position?

optional position: [number, number, number]

camera.quaternion?

optional quaternion: [number, number, number, number]

camera.rotation?

optional rotation: [number, number, number]

defaultLighting?

optional defaultLighting: boolean

Generate a default gradient environment and background.

Default Value

true

far?

optional far: number

Far clipping plane.

Default Value

200

fov?

optional fov: number

Camera field of view in degrees.

Default Value

50

near?

optional near: number

Near clipping plane.

Default Value

0.1

stencil?

optional stencil: boolean

Enable stencil buffer.

Default Value

false

---

xr?

optional xr: false | XROptions & object

Defined in: packages/core/src/init/world-initializer.ts:104

XR session options and offer behavior. Set to false for browser-only worlds.