ThreeplayOpts

Defined in: packages/threeplay/src/core/types.ts:176

Options of threeplay(). Plugins extend this interface with their own options through declaration merging (there is no catch-all index signature, so a typo like widht is a type error):

declare module "threeplay" {
  interface ThreeplayOpts { myPluginSpeed?: number }
}

Extends

• DebugOpts
• InputOpts
• PhysicsOpts
• RenderOpts

Extended by

• ThreeplayInit

Properties

antialias?

optional antialias?: boolean

Defined in: packages/threeplay/src/plugins/render/types.ts:58

Antialiasing (default true).

Inherited from

RenderOpts.antialias

---

background?

optional background?: ColorLike | null

Defined in: packages/threeplay/src/plugins/render/types.ts:52

Clear color (default a soft sky blue). null keeps the canvas transparent.

Inherited from

RenderOpts.background

---

buttons?

optional buttons?: Record<string, ButtonBinding>

Defined in: packages/threeplay/src/plugins/input/types.ts:40

Virtual buttons: { jump: { keyboard: ["space", "w"], gamepad: "south" } }. Merged over the defaults, which exist even if you pass nothing: left (arrows, A), right (arrows, D), up (arrows, W), down (arrows, S) and jump (space), each with its d-pad / south gamepad button. Redefining a name replaces its default binding entirely.

Inherited from

InputOpts.buttons

---

canvas?

optional canvas?: HTMLCanvasElement

Defined in: packages/threeplay/src/plugins/render/types.ts:48

Draw into this canvas instead of creating one.

Inherited from

RenderOpts.canvas

---

debug?

optional debug?: boolean

Defined in: packages/threeplay/src/plugins/debug/types.ts:12

Start with the inspector on.

Inherited from

DebugOpts.debug

---

debugKey?

optional debugKey?: string | false

Defined in: packages/threeplay/src/plugins/debug/types.ts:10

Key that toggles the inspector (default "f1"; false disables it). Needs the input plugin (an optional dependency: without it the key does nothing). The browser default of the key is prevented while the canvas has focus (F1 would open help on Windows).

Inherited from

DebugOpts.debugKey

---

fixedHz?

optional fixedHz?: number

Defined in: packages/threeplay/src/core/types.ts:182

Fixed update rate in Hz, used by physics (default 50).

---

global?

optional global?: boolean

Defined in: packages/threeplay/src/core/types.ts:178

Put the API on window like kaplay does (default true).

---

height?

optional height?: number

Defined in: packages/threeplay/src/plugins/render/types.ts:44

Inherited from

RenderOpts.height

---

letterbox?

optional letterbox?: boolean

Defined in: packages/threeplay/src/plugins/render/types.ts:46

Keep the aspect ratio with bars when scaling (default true with width/height).

Inherited from

RenderOpts.letterbox

---

lighting?

optional lighting?: "none" | "default"

Defined in: packages/threeplay/src/plugins/render/types.ts:62

"default" adds a hemisphere light and a sun with shadows; "none" adds nothing.

Inherited from

RenderOpts.lighting

---

loop?

optional loop?: "auto" | "manual"

Defined in: packages/threeplay/src/core/types.ts:184

"auto" drives the loop with requestAnimationFrame; "manual" waits for k.step(dt).

---

maxDt?

optional maxDt?: number

Defined in: packages/threeplay/src/core/types.ts:186

Largest frame delta in seconds; longer frames are clamped (default 0.1).

---

physics?

optional physics?: boolean | { gravity?: number | Vec3Like; }

Defined in: packages/threeplay/src/plugins/physics/types.ts:189

false disables physics (Rapier is not downloaded). Default true.

Inherited from

PhysicsOpts.physics

---

pixelRatio?

optional pixelRatio?: number

Defined in: packages/threeplay/src/plugins/render/types.ts:56

Device pixel ratio cap (default Math.min(devicePixelRatio, 2)).

Inherited from

RenderOpts.pixelRatio

---

plugins?

optional plugins?: PluginLike[]

Defined in: packages/threeplay/src/core/types.ts:180

Extra plugins, installed after the built-in ones.

---

renderer?

optional renderer?: "auto" | RendererKind

Defined in: packages/threeplay/src/plugins/render/types.ts:54

"auto" (WebGPU with WebGL2 fallback, default), "webgpu", "webgl" or "none" (headless).

Inherited from

RenderOpts.renderer

---

root?

optional root?: HTMLElement

Defined in: packages/threeplay/src/plugins/render/types.ts:50

Element that receives the canvas and overlays (default document.body).

Inherited from

RenderOpts.root

---

shadows?

optional shadows?: boolean

Defined in: packages/threeplay/src/plugins/render/types.ts:60

Shadow maps (default true).

Inherited from

RenderOpts.shadows

---

width?

optional width?: number

Defined in: packages/threeplay/src/plugins/render/types.ts:43

Logical width. With width and height the game thinks in a fixed size (HUD coordinates, aspect) and the canvas is scaled to the container. Without them the canvas fills the container and the logical size follows it.

Inherited from

RenderOpts.width