1681-engine / index / rumble

Function: rumble()

ts

function rumble(
   padIndex, 
   options, 
   pads?
): Promise<boolean>;

Defined in: src/input/rumble.ts:65

Rumbles the pad at padIndex (as in navigator.getGamepads()); resolves false where it cannot.

Parameters

Parameter	Type	Default value
`padIndex`	`number`	`undefined`
`options`	`RumbleOptions`	`undefined`
`pads`	() => readonly (`RumblePad` \| `null`)[]	`navigatorPads`

Returns

Promise<boolean>