Class GamepadDevice

Per-controller façade over the browser Gamepad object: named buttons/axes, gesture helpers, rumble, and snapshots.

Remarks

Obtain instances from GamepadManager.onConnect or GamepadManager.getDevices. Every on* subscription returns a disposer—call it to remove listeners when UI unmounts or gameplay state changes.

Implements

IGamepadDevice

Index

Constructors

constructor

new GamepadDevice(
    raw: Gamepad,
    layout: LayoutProfile,
    deadzone: ResolvedDeadzone,
): GamepadDevice
Parameters
- raw: Gamepad
- layout: LayoutProfile
- deadzone: ResolvedDeadzone
Returns GamepadDevice
- Defined in GamepadDevice.ts:128

Properties

`Readonly`id

id: string

`Readonly`index

index: number

Accessors

hasVibration

get hasVibration(): boolean
Returns boolean
Implementation of IGamepadDevice.hasVibration
- Defined in GamepadDevice.ts:141

layout

get layout(): LayoutProfile
Returns LayoutProfile
Implementation of IGamepadDevice.layout
- Defined in GamepadDevice.ts:139

raw

get raw(): Gamepad
Returns Gamepad
Implementation of IGamepadDevice.raw
- Defined in GamepadDevice.ts:137

Methods

axis

axis(name: AxisName): AxisState
Parameters
- name: AxisName
Returns AxisState
Implementation of IGamepadDevice.axis
- Defined in GamepadDevice.ts:549

button

button(button: ButtonName): { pressed: boolean; value: number } | undefined
Parameters
- button: ButtonName
Returns { pressed: boolean; value: number } | undefined
Implementation of IGamepadDevice.button
- Defined in GamepadDevice.ts:562

isPressed

isPressed(button: ButtonName): boolean
Parameters
- button: ButtonName
Returns boolean
Implementation of IGamepadDevice.isPressed
- Defined in GamepadDevice.ts:556

onAnyPress

onAnyPress(handler: (e: ButtonEvent) => void): Disposer
Any named button on this device
Parameters
- handler: (e: ButtonEvent) => void
Returns Disposer
Implementation of IGamepadDevice.onAnyPress
- Defined in GamepadDevice.ts:544

onAxisFlick

onAxisFlick(
    axis: AxisName,
    direction: AxisFlickDirection,
    optsOrHandler: AxisFlickOptions | ((e: AxisEvent) => void),
    handler?: (e: AxisEvent) => void,
): Disposer
Parameters
- axis: AxisName
- direction: AxisFlickDirection
- optsOrHandler: AxisFlickOptions | ((e: AxisEvent) => void)
- Optionalhandler: (e: AxisEvent) => void
Returns Disposer
Implementation of IGamepadDevice.onAxisFlick
- Defined in GamepadDevice.ts:519

onAxisMove

onAxisMove(axis: AxisName, handler: (e: AxisEvent) => void): Disposer
Parameters
- axis: AxisName
- handler: (e: AxisEvent) => void
Returns Disposer
Implementation of IGamepadDevice.onAxisMove
- Defined in GamepadDevice.ts:508

onChange

onChange(handler: (snap: GamepadSnapshot) => void): Disposer
Fires when the serializable snapshot differs from the previous frame
Parameters
- handler: (snap: GamepadSnapshot) => void
Returns Disposer
Implementation of IGamepadDevice.onChange
- Defined in GamepadDevice.ts:539

onCombo

onCombo(buttons: ButtonName[], handler: (e: ButtonEvent[]) => void): Disposer
Parameters
- buttons: ButtonName[]
- handler: (e: ButtonEvent[]) => void
Returns Disposer
Implementation of IGamepadDevice.onCombo
- Defined in GamepadDevice.ts:441

onDoubleTap

onDoubleTap(
    button: ButtonName,
    optsOrHandler: DoubleTapOptions | ((e: ButtonEvent) => void),
    handler?: (e: ButtonEvent) => void,
): Disposer
Parameters
- button: ButtonName
- optsOrHandler: DoubleTapOptions | ((e: ButtonEvent) => void)
- Optionalhandler: (e: ButtonEvent) => void
Returns Disposer
Implementation of IGamepadDevice.onDoubleTap
- Defined in GamepadDevice.ts:425

onFrame

onFrame(handler: (device: IGamepadDevice) => void): Disposer
Parameters
- handler: (device: IGamepadDevice) => void
Returns Disposer
Implementation of IGamepadDevice.onFrame
- Defined in GamepadDevice.ts:599

onHold

onHold(
    button: ButtonName,
    optsOrHandler: HoldOptions | ((e: ButtonEvent) => void),
    handler?: (e: ButtonEvent) => void,
): Disposer
Parameters
- button: ButtonName
- optsOrHandler: HoldOptions | ((e: ButtonEvent) => void)
- Optionalhandler: (e: ButtonEvent) => void
Returns Disposer
Implementation of IGamepadDevice.onHold
- Defined in GamepadDevice.ts:388

onLongPress

onLongPress(
    button: ButtonName,
    optsOrHandler: LongPressOptions | ((e: ButtonEvent) => void),
    handler?: (e: ButtonEvent) => void,
): Disposer
Parameters
- button: ButtonName
- optsOrHandler: LongPressOptions | ((e: ButtonEvent) => void)
- Optionalhandler: (e: ButtonEvent) => void
Returns Disposer
Implementation of IGamepadDevice.onLongPress
- Defined in GamepadDevice.ts:408

onPress

onPress(button: ButtonName, handler: (e: ButtonEvent) => void): Disposer
Parameters
- button: ButtonName
- handler: (e: ButtonEvent) => void
Returns Disposer
Implementation of IGamepadDevice.onPress
- Defined in GamepadDevice.ts:366

onRelease

onRelease(button: ButtonName, handler: (e: ButtonEvent) => void): Disposer
Parameters
- button: ButtonName
- handler: (e: ButtonEvent) => void
Returns Disposer
Implementation of IGamepadDevice.onRelease
- Defined in GamepadDevice.ts:377

onSequence

onSequence(
    buttons: ButtonName[],
    optsOrHandler: SequenceOptions | (() => void),
    handler?: () => void,
): Disposer
Parameters
- buttons: ButtonName[]
- optsOrHandler: SequenceOptions | (() => void)
- Optionalhandler: () => void
Returns Disposer
Implementation of IGamepadDevice.onSequence
- Defined in GamepadDevice.ts:450

onTrigger

onTrigger(trigger: "LT" | "RT", handler: (e: TriggerEvent) => void): Disposer
Parameters
- trigger: "LT" | "RT"
- handler: (e: TriggerEvent) => void
Returns Disposer
Implementation of IGamepadDevice.onTrigger
- Defined in GamepadDevice.ts:466

onTriggerPress

onTriggerPress(
    trigger: "LT" | "RT",
    optsOrHandler: TriggerThresholdOptions | ((e: TriggerEvent) => void),
    handler?: (e: TriggerEvent) => void,
): Disposer
Parameters
- trigger: "LT" | "RT"
- optsOrHandler: TriggerThresholdOptions | ((e: TriggerEvent) => void)
- Optionalhandler: (e: TriggerEvent) => void
Returns Disposer
Implementation of IGamepadDevice.onTriggerPress
- Defined in GamepadDevice.ts:476

onTriggerRelease

onTriggerRelease(
    trigger: "LT" | "RT",
    optsOrHandler: TriggerThresholdOptions | ((e: TriggerEvent) => void),
    handler?: (e: TriggerEvent) => void,
): Disposer
Parameters
- trigger: "LT" | "RT"
- optsOrHandler: TriggerThresholdOptions | ((e: TriggerEvent) => void)
- Optionalhandler: (e: TriggerEvent) => void
Returns Disposer
Implementation of IGamepadDevice.onTriggerRelease
- Defined in GamepadDevice.ts:492

setDeadzone

setDeadzone(deadzone: number | DeadzoneOptions | undefined): void
Parameters
- deadzone: number | DeadzoneOptions | undefined
Returns void
Implementation of IGamepadDevice.setDeadzone
- Defined in GamepadDevice.ts:150

setLayout

setLayout(layout: LayoutProfile): void
Parameters
- layout: LayoutProfile
Returns void
Implementation of IGamepadDevice.setLayout
- Defined in GamepadDevice.ts:145

snapshot

snapshot(): GamepadSnapshot
Returns GamepadSnapshot
Implementation of IGamepadDevice.snapshot
- Defined in GamepadDevice.ts:576

stopVibration

stopVibration(): void
Returns void
Implementation of IGamepadDevice.stopVibration
- Defined in GamepadDevice.ts:604

trigger

trigger(name: "LT" | "RT"): number
Parameters
- name: "LT" | "RT"
Returns number
Implementation of IGamepadDevice.trigger
- Defined in GamepadDevice.ts:570

vibrate

vibrate(options: VibrateSingleOptions): Promise<void>
Parameters
- options: VibrateSingleOptions
Returns Promise<void>
Implementation of IGamepadDevice.vibrate
- Defined in GamepadDevice.ts:610

vibrateDual

vibrateDual(options: VibrateDualOptions): Promise<void>
Parameters
- options: VibrateDualOptions
Returns Promise<void>
Implementation of IGamepadDevice.vibrateDual
- Defined in GamepadDevice.ts:647

vibratePattern

vibratePattern(options: VibratePatternOptions): Promise<void>
Parameters
- options: VibratePatternOptions
Returns Promise<void>
Implementation of IGamepadDevice.vibratePattern
- Defined in GamepadDevice.ts:633

Class GamepadDevice

Remarks

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GamepadDevice

Properties

Readonlyid

Readonlyindex

Accessors

hasVibration

Returns boolean

layout

Returns LayoutProfile

raw

Returns Gamepad

Methods

axis

Parameters

Returns AxisState

button

Parameters

Returns { pressed: boolean; value: number } | undefined

isPressed

Parameters

Returns boolean

onAnyPress

Parameters

Returns Disposer

onAxisFlick

Parameters

Returns Disposer

onAxisMove

Parameters

Returns Disposer

onChange

Parameters

Returns Disposer

onCombo

Parameters

Returns Disposer

onDoubleTap

Parameters

Returns Disposer

onFrame

Parameters

Returns Disposer

onHold

Parameters

Returns Disposer

onLongPress

Parameters

Returns Disposer

onPress

Parameters

Returns Disposer

onRelease

Parameters

Returns Disposer

onSequence

Parameters

Returns Disposer

onTrigger

Parameters

Returns Disposer

onTriggerPress

Parameters

Returns Disposer

onTriggerRelease

Parameters

Returns Disposer

setDeadzone

Parameters

Returns void

`Readonly`id

`Readonly`index