Class: GamepadHelper

Constructor

new GamepadHelper()

Source: gamepad-helper.js, line 5

Members

CONTROLLER_TYPES :Object

Controller Types

Type:

Object

Properties

Name	Type	Description
`XBOX`	string	Xbox family of controllers
`PLAYSTATION`	string	PlayStation family of controllers
`SWITCH`	string	Nintendo Switch controllers
`STANDARD`	string	Generic or standard controllers

Source: gamepad-helper.js, line 15

controllerMappings :Object.<string, {buttonMap: Object.<number, string>, axisMap: Object.<number, string>}>

Controller Mappings Maps controller types to their respective button and axis mappings.

Type:

Object.<string, {buttonMap: Object.<number, string>, axisMap: Object.<number, string>}>

Source: gamepad-helper.js, line 134

exactGamepadMappings :Object.<number, {name: string, gamepad_api_ids: Array.<string>, type: string}>

Exact Gamepad Mappings This object maps specific gamepad API IDs to controller types and names.

Type:

Object.<number, {name: string, gamepad_api_ids: Array.<string>, type: string}>

Source: gamepad-helper.js, line 27

exactIdLookup :Object.<string, {name: string, gamepad_api_ids: Array.<string>, type: string}>

Exact ID Lookup This object maps gamepad API IDs to their respective controller mappings.

Type:

Object.<string, {name: string, gamepad_api_ids: Array.<string>, type: string}>

Source: gamepad-helper.js, line 122

Methods

detectControllerType(gamepadId) → {string}

Detect the controller type based on the gamepad ID

Parameters:

Name	Type	Description
`gamepadId`	string \| null	The ID of the gamepad as given by the Gamepad API

Source: gamepad-helper.js, line 386

Returns:

The type of controller (XBOX, PLAYSTATION, SWITCH, STANDARD)

Type:: string

getAxisName(controllerType, axisIndex) → {string}

Get axis name for given controller type and axis index

Parameters:

Name	Type	Description
`controllerType`	string	The type of controller (XBOX, PLAYSTATION, SWITCH, STANDARD)
`axisIndex`	number	The index of the axis

Source: gamepad-helper.js, line 407

Returns:

The name of the axis (e.g., 'Left Stick X', 'Right Stick Y', etc.)

Type:: string

getButtonImagePath(controllerType, buttonIndex, basePathopt, buttonColoropt, buttonTypeopt) → {string|null}

Get the image path for a specific button on a controller

Parameters:

Name	Type	Attributes	Default	Description
`controllerType`	string			The type of controller (XBOX, PLAYSTATION, SWITCH)
`buttonIndex`	number			The index of the button
`basePath`	string	<optional>	'/assets/img/gamepads/'	The base path for the images
`buttonColor`	string	<optional>	'White'	The color of the button ('Black' or 'White')
`buttonType`	string	<optional>	'Outline'	The type of button ('Outline', 'Solid', 'Full Solid')

Source: gamepad-helper.js, line 246

Returns:

The path to the button image or null if not found

Type:: string | null

getButtonName(controllerType, buttonIndex) → {string}

Get button name for given controller type and button index

Parameters:

Name	Type	Description
`controllerType`	string	The type of controller (XBOX, PLAYSTATION, SWITCH, STANDARD)
`buttonIndex`	number	The index of the button

Source: gamepad-helper.js, line 396

Returns:

The name of the button (e.g., 'A', 'B', 'X', etc.)

Type:: string

getConnectedGamepads() → {Array.<Gamepad>}

Get all connected gamepads

Source: gamepad-helper.js, line 518

Returns:

Array of connected gamepad objects

Type:: Array.<Gamepad>

getGamepadInfo(gamepadId) → {Object}

Get gamepad information based on the gamepad ID

Parameters:

Name	Type	Description
`gamepadId`	string \| null	The ID of the gamepad as given by the Gamepad API

Source: gamepad-helper.js, line 358

Returns:

Controller type and name information

Type:: Object

getVibrationCapabilities(gamepad) → {Object}

Get vibration capabilities of the gamepad

Parameters:

Name	Type	Description
`gamepad`	Gamepad \| null	The gamepad object from the Gamepad API

Source: gamepad-helper.js, line 426

Returns:

Vibration capabilities information

Type:: Object

isSupported() → {boolean}

Check if the Gamepad API is supported in the current browser

Source: gamepad-helper.js, line 349

Returns:

True if supported, false otherwise

Type:: boolean

isVibrationSupported(gamepad) → {boolean}

Check if vibration is supported on the gamepad

Parameters:

Name	Type	Description
`gamepad`	Gamepad \| null	The gamepad object from the Gamepad API

Source: gamepad-helper.js, line 417

Returns:

True if vibration is supported, false otherwise

Type:: boolean

stopVibration(gamepad) → {Promise.<(GamepadHapticsResult|Error)>}

Stop vibration on the gamepad

Parameters:

Name	Type	Description
`gamepad`	Gamepad \| null	The gamepad object from the Gamepad API

Source: gamepad-helper.js, line 506

Returns:

Promise that resolves when vibration stops

Type:: Promise.<(GamepadHapticsResult|Error)>

vibrate(gamepad, optionsopt) → {Promise.<(GamepadHapticsResult|Error)>}

Vibrate the gamepad

Parameters:

Name Type Attributes Default Description

gamepad

Gamepad | null

The gamepad object from the Gamepad API

options

Object

{}

Options for vibration

Properties

Name	Type	Attributes	Default	Description
`weakMagnitude`	number	<optional>	0.5	Weak rumble magnitude (0-1)
`strongMagnitude`	number	<optional>	0.5	Strong rumble magnitude (0-1)
`duration`	number	<optional>	1000	Duration in milliseconds
`startDelay`	number	<optional>	0	Start delay in milliseconds

Source: gamepad-helper.js, line 447

Returns:

Promise that resolves when vibration completes

Type:: Promise.<(GamepadHapticsResult|Error)>