Input

Defined in: engine/src/input/core.ts:131

Edge queries (pressed, released, padPressed, virtualPressed, ...) report what changed between the last two update() calls, so call update() once per frame before reading them.

PropertiesCopy Anchor Link

MethodsCopy Anchor Link

active()Copy Anchor Link

active(): boolean;

Defined in: engine/src/input/core.ts:182

True while anything is being held; render continuously while it is.

ReturnsCopy Anchor Link

boolean

captureKeys()Copy Anchor Link

captureKeys(codes: Iterable<string>): void;

Defined in: engine/src/input/core.ts:153

Only these codes have their default action prevented (so bound keys don't scroll).

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

void

claim()Copy Anchor Link

claim(pointerId: number, owner: object): boolean;

Defined in: engine/src/input/core.ts:142

Reserve a pointer for one owner; others should ignore it (claimedBy).

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

boolean

claimedBy()Copy Anchor Link

claimedBy(pointerId: number): object | undefined;

Defined in: engine/src/input/core.ts:144

The owner that claimed a pointer, if any. Claims are released when the pointer lifts.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

object | undefined

dispose()Copy Anchor Link

dispose(): void;

Defined in: engine/src/input/core.ts:188

Remove every listener, drop all state and release pointer lock.

ReturnsCopy Anchor Link

void

down()Copy Anchor Link

down(code: string): boolean;

Defined in: engine/src/input/core.ts:147

Key held (by KeyboardEvent.code).

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

boolean

gamepad()Copy Anchor Link

gamepad(): GamepadState | null;

Defined in: engine/src/input/core.ts:156

The first connected gamepad, as of the last update().

ReturnsCopy Anchor Link

GamepadState | null

lastDevice()Copy Anchor Link

lastDevice(): Device;

Defined in: engine/src/input/core.ts:184

What was used last, for showing the right prompts or touch controls.

ReturnsCopy Anchor Link

Device

lock()Copy Anchor Link

lock(): void;

Defined in: engine/src/input/core.ts:173

Ask for pointer lock (must be called from a user gesture).

ReturnsCopy Anchor Link

void

locked()Copy Anchor Link

locked(): boolean;

Defined in: engine/src/input/core.ts:177

This surface holds pointer lock; mouse movement then arrives as look events.

ReturnsCopy Anchor Link

boolean

on()Copy Anchor Link

on(fn: (e: InputEvent) => void, priority?: number): () => void;

Defined in: engine/src/input/core.ts:140

Listen to normalised events. Higher priority hears them first; see claim. Returns an unsubscribe.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

() => void

onDevice()Copy Anchor Link

onDevice(fn: (d: Device) => void): () => void;

Defined in: engine/src/input/core.ts:186

Called when lastDevice() changes. Returns an unsubscribe.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

() => void

padPressed()Copy Anchor Link

padPressed(button: 
  | "A"
  | "B"
  | "X"
  | "Y"
  | "LB"
  | "RB"
  | "LT"
  | "RT"
  | "Back"
  | "Start"
  | "LS"
  | "RS"
  | "DUp"
  | "DDown"
  | "DLeft"
  | "DRight"
  | "Home"): boolean;

Defined in: engine/src/input/core.ts:158

Button crossed half-way down / up between the last two update() calls.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

boolean

padReleased()Copy Anchor Link

padReleased(button: 
  | "A"
  | "B"
  | "X"
  | "Y"
  | "LB"
  | "RB"
  | "LT"
  | "RT"
  | "Back"
  | "Start"
  | "LS"
  | "RS"
  | "DUp"
  | "DDown"
  | "DLeft"
  | "DRight"
  | "Home"): boolean;

Defined in: engine/src/input/core.ts:159

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

boolean

pointers()Copy Anchor Link

pointers(): ReadonlyMap<number, PointerState>;

Defined in: engine/src/input/core.ts:135

Live pointers, by id.

ReturnsCopy Anchor Link

ReadonlyMap<number, PointerState>

pressed()Copy Anchor Link

pressed(code: string): boolean;

Defined in: engine/src/input/core.ts:149

Went down / up since the previous update().

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

boolean

released()Copy Anchor Link

released(code: string): boolean;

Defined in: engine/src/input/core.ts:151

Went up since the previous update().

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

boolean

setVirtual()Copy Anchor Link

setVirtual(name: string, value: number): void;

Defined in: engine/src/input/core.ts:165

Set a value on the virtual channel, read by touch:<name> action sources. On-screen controls call this; a non-zero value also marks touch as the last device. 0 removes the entry.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

void

unlock()Copy Anchor Link

unlock(): void;

Defined in: engine/src/input/core.ts:175

Release pointer lock if this surface holds it.

ReturnsCopy Anchor Link

void

update()Copy Anchor Link

update(): void;

Defined in: engine/src/input/core.ts:180

Once per frame, before reading: advances edges and polls the gamepad.

ReturnsCopy Anchor Link

void

virtual()Copy Anchor Link

virtual(name: string): number;

Defined in: engine/src/input/core.ts:167

Current virtual value, 0 when unset.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

number

virtualPressed()Copy Anchor Link

virtualPressed(name: string): boolean;

Defined in: engine/src/input/core.ts:169

Became non-zero / returned to zero between the last two update() calls.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

boolean

virtualReleased()Copy Anchor Link

virtualReleased(name: string): boolean;

Defined in: engine/src/input/core.ts:170

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

boolean