Class GamepadManager

Central coordinator for browser gamepads: a single requestAnimationFrame loop, connection listeners, and GamepadDevice instances keyed by gamepad index.

Remarks

Call GamepadManager.start to attach listeners and begin polling; GamepadManager.stop tears everything down.
Subscribing to GamepadManager.onConnect, GamepadManager.onDisconnect, GamepadManager.onAnyPress, or GamepadManager.onAnyInput automatically starts an idle manager.
In non-browser environments (SSR/tests) GamepadManager.start is a no-op until window exists.

Implements

IGamepadManager

Index

Constructors

Methods

getDevice getDevices onAnyInput onAnyPress onConnect onDisconnect setDeadzone setLayoutForId start stop

Constructors

constructor

new GamepadManager(options?: ManagerOptions): GamepadManager
Parameters
- options: ManagerOptions = {}
Returns GamepadManager
- Defined in GamepadManager.ts:29

Methods

getDevice

getDevice(index: number): GamepadDevice | undefined
Parameters
- index: number
Returns GamepadDevice | undefined
Implementation of IGamepadManager.getDevice
- Defined in GamepadManager.ts:71

getDevices

getDevices(): GamepadDevice[]
Returns GamepadDevice[]
Implementation of IGamepadManager.getDevices
- Defined in GamepadManager.ts:63

onAnyInput

onAnyInput(handler: (pad: GamepadDevice) => void): () => void
Parameters
- handler: (pad: GamepadDevice) => void
Returns () => void
Implementation of IGamepadManager.onAnyInput
- Defined in GamepadManager.ts:104

onAnyPress

onAnyPress(handler: (e: ButtonEvent, pad: GamepadDevice) => void): () => void
Parameters
- handler: (e: ButtonEvent, pad: GamepadDevice) => void
Returns () => void
Implementation of IGamepadManager.onAnyPress
- Defined in GamepadManager.ts:91

onConnect

onConnect(handler: (device: GamepadDevice) => void): () => void
Parameters
- handler: (device: GamepadDevice) => void
Returns () => void
Implementation of IGamepadManager.onConnect
- Defined in GamepadManager.ts:75

onDisconnect

onDisconnect(handler: (device: GamepadDevice) => void): () => void
Parameters
- handler: (device: GamepadDevice) => void
Returns () => void
Implementation of IGamepadManager.onDisconnect
- Defined in GamepadManager.ts:83

setDeadzone

setDeadzone(deadzone: number | DeadzoneOptions | undefined): void
Update stick deadzone for this manager and all connected devices
Parameters
- deadzone: number | DeadzoneOptions | undefined
Returns void
Implementation of IGamepadManager.setDeadzone
- Defined in GamepadManager.ts:127

setLayoutForId

setLayoutForId(idPattern: string, layout: LayoutProfile): void
Substring match on gamepad.id (case-insensitive); reapplies to connected devices
Parameters
- idPattern: string
- layout: LayoutProfile
Returns void
Implementation of IGamepadManager.setLayoutForId
- Defined in GamepadManager.ts:117

start

start(): this
Auto-starts on first subscription (onConnect / onAny*)

Returns this
Implementation of IGamepadManager.start
- Defined in GamepadManager.ts:34

stop

stop(): this
Returns this
Implementation of IGamepadManager.stop
- Defined in GamepadManager.ts:50