Interface InputState<A>

interface InputState<A extends string = string> {
    actions: ActionState<A>;
    gamepads: readonly GamepadState[];
    keyboard: KeyboardState;
    pointer: PointerState;
    definePlayer(id: string, map: ActionMap<A>): void;
    getActionMap(): Readonly<ActionMap<A>>;
    player(id: string): PlayerInput<A> | undefined;
    playerIds(): readonly string[];
    removePlayer(id: string): boolean;
    setActionMap(actions: ActionMap<A>): void;
}

Type Parameters

A extends string = string

Index

Properties

actions gamepads keyboard pointer

Methods

definePlayer getActionMap player playerIds removePlayer setActionMap

Properties

`Readonly`actions

actions: ActionState<A>

Unified action state — fires when any bound input (keyboard, pointer, any pad) is active. Intended for menu/shared input.

`Readonly`gamepads

gamepads: readonly GamepadState[]

Always length 4 (standard web gamepad slot count). Disconnected slots return connected: false.

`Readonly`keyboard

keyboard: KeyboardState

`Readonly`pointer

pointer: PointerState

Methods

definePlayer

definePlayer(id: string, map: ActionMap<A>): void
Register or replace a player's action map. Per-player states are isolated from the unified actions.
Parameters
- id: string
- map: ActionMap<A>
Returns void
- Defined in plugins/input/input.ts:198

getActionMap

getActionMap(): Readonly<ActionMap<A>>
Returns Readonly<ActionMap<A>>
- Defined in plugins/input/input.ts:196

player

player(id: string): PlayerInput<A> | undefined
Returns a handle to a registered player's input, or undefined if no such player.
Parameters
- id: string
Returns PlayerInput<A> | undefined
- Defined in plugins/input/input.ts:202

playerIds

playerIds(): readonly string[]
Returns readonly string[]
- Defined in plugins/input/input.ts:203

removePlayer

removePlayer(id: string): boolean
Returns true if the player existed and was removed.
Parameters
- id: string
Returns boolean
- Defined in plugins/input/input.ts:200

setActionMap

setActionMap(actions: ActionMap<A>): void
Parameters
- actions: ActionMap<A>
Returns void
- Defined in plugins/input/input.ts:195