Interface GamepadHapticActuator

The GamepadHapticActuator interface of the Gamepad API represents hardware in the controller designed to provide haptic feedback to the user (if available), most commonly vibration hardware.

MDN Reference

interface GamepadHapticActuator {
    playEffect(
        type: GamepadHapticEffectType,
        params?: GamepadEffectParameters,
    ): Promise<GamepadHapticsResult>;
    reset(): Promise<GamepadHapticsResult>;
}

Index

Methods

playEffect reset

Methods

playEffect

playEffect(
type: GamepadHapticEffectType,
params?: GamepadEffectParameters,
): Promise<GamepadHapticsResult>
The playEffect() method of the GamepadHapticActuator interface causes the hardware to play a specific vibration effect.

MDN Reference
Parameters
- type: GamepadHapticEffectType
- Optionalparams: GamepadEffectParameters
Returns Promise<GamepadHapticsResult>

reset

reset(): Promise<GamepadHapticsResult>
The reset() method of the GamepadHapticActuator interface stops the hardware from playing an active vibration effect.

MDN Reference

Returns Promise<GamepadHapticsResult>

Interface GamepadHapticActuator

Index

Methods

Methods

playEffect

Parameters

Returns Promise<GamepadHapticsResult>

reset

Returns Promise<GamepadHapticsResult>

Settings

On This Page