GamepadSettings | References | ArcGIS Maps SDK for JavaScript

import GamepadSettings from "@arcgis/core/views/input/gamepad/GamepadSettings.js";

Inheritance:: GamepadSettings→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.9

Gamepad input specific configuration settings.

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`GamepadSettingsProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`devices` readonly	`Collection<GamepadInputDevice>`
`enabledFocusMode`	`"document" \| "view" \| "none"`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

devices

readonly Property

Type: Collection<GamepadInputDevice>

A readonly collection of all gamepads detected. This collection can be monitored for connecting and disconnecting gamepads. This property may only be populated after interaction with a connected gamepad device. See example below.

Example

const { devices } = view.input.gamepad;
devices.on("change", () => {
  console.log(`Available devices...`);
  for (const gamepad of devices) {
    const { id, index } = gamepad.native;
    console.log(`
      Device name:  ${id}
      Device index: ${index}
    `);
  }
});

enabledFocusMode

Property

Type: "document" | "view" | "none"

Determines what focus is required for gamepad events to be dispatched.

Possible Value	Description
document	Gamepad events are emitted when any part of the current webpage has focus. This allows for gamepad events being emitted even while a UI element is focused.
view	Gamepad events are emitted when the view's container element has browser focus. This is useful when multiple views might be present on a single webpage.
none	Gamepad events are emitted independently of focus.

Default value: "document"