play-u1 API
    Preparing search index...

    Interface IGamepadDevice

    interface IGamepadDevice {
        id: string;
        index: number;
        layout: LayoutProfile;
        raw: Gamepad;
        get hasVibration(): boolean;
        axis(name: AxisName): AxisState;
        button(button: ButtonName): { pressed: boolean; value: number } | undefined;
        isPressed(button: ButtonName): boolean;
        onAnyPress(handler: (e: ButtonEvent) => void): Disposer;
        onAxisFlick(
            axis: AxisName,
            direction: AxisFlickDirection,
            handler: (e: AxisEvent) => void,
        ): Disposer;
        onAxisFlick(
            axis: AxisName,
            direction: AxisFlickDirection,
            options: AxisFlickOptions,
            handler: (e: AxisEvent) => void,
        ): Disposer;
        onAxisMove(axis: AxisName, handler: (e: AxisEvent) => void): Disposer;
        onChange(handler: (snap: GamepadSnapshot) => void): Disposer;
        onCombo(
            buttons: ButtonName[],
            handler: (e: ButtonEvent[]) => void,
        ): Disposer;
        onDoubleTap(
            button: ButtonName,
            handler: (e: ButtonEvent) => void,
        ): Disposer;
        onDoubleTap(
            button: ButtonName,
            options: DoubleTapOptions,
            handler: (e: ButtonEvent) => void,
        ): Disposer;
        onFrame(handler: (device: IGamepadDevice) => void): Disposer;
        onHold(button: ButtonName, handler: (e: ButtonEvent) => void): Disposer;
        onHold(
            button: ButtonName,
            options: HoldOptions,
            handler: (e: ButtonEvent) => void,
        ): Disposer;
        onLongPress(
            button: ButtonName,
            handler: (e: ButtonEvent) => void,
        ): Disposer;
        onLongPress(
            button: ButtonName,
            options: LongPressOptions,
            handler: (e: ButtonEvent) => void,
        ): Disposer;
        onPress(button: ButtonName, handler: (e: ButtonEvent) => void): Disposer;
        onRelease(button: ButtonName, handler: (e: ButtonEvent) => void): Disposer;
        onSequence(buttons: ButtonName[], handler: () => void): Disposer;
        onSequence(
            buttons: ButtonName[],
            options: SequenceOptions,
            handler: () => void,
        ): Disposer;
        onTrigger(
            trigger: "LT" | "RT",
            handler: (e: TriggerEvent) => void,
        ): Disposer;
        onTriggerPress(
            trigger: "LT" | "RT",
            handler: (e: TriggerEvent) => void,
        ): Disposer;
        onTriggerPress(
            trigger: "LT" | "RT",
            options: TriggerThresholdOptions,
            handler: (e: TriggerEvent) => void,
        ): Disposer;
        onTriggerRelease(
            trigger: "LT" | "RT",
            handler: (e: TriggerEvent) => void,
        ): Disposer;
        onTriggerRelease(
            trigger: "LT" | "RT",
            options: TriggerThresholdOptions,
            handler: (e: TriggerEvent) => void,
        ): Disposer;
        setDeadzone(deadzone: number | DeadzoneOptions | undefined): void;
        setLayout(layout: LayoutProfile): void;
        snapshot(): GamepadSnapshot;
        stopVibration(): void;
        trigger(name: "LT" | "RT"): number;
        vibrate(options: VibrateSingleOptions): Promise<void>;
        vibrateDual(options: VibrateDualOptions): Promise<void>;
        vibratePattern(options: VibratePatternOptions): Promise<void>;
    }

    Implemented by

    Index

    Properties

    id index layout raw

    Accessors

    hasVibration

    Methods

    axis button isPressed onAnyPress onAxisFlick onAxisMove onChange onCombo onDoubleTap onFrame onHold onLongPress onPress onRelease onSequence onTrigger onTriggerPress onTriggerRelease setDeadzone setLayout snapshot stopVibration trigger vibrate vibrateDual vibratePattern

    Properties

    id: string
    index: number
    layout: LayoutProfile
    raw: Gamepad

    Accessors

    • get hasVibration(): boolean

      Returns boolean

    Methods

    • Parameters

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

    • Parameters

      Returns boolean

    • Parameters

      Returns void

    • Returns void

    • Parameters

      • name: "LT" | "RT"

      Returns number

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods