GamepadSettings

Property Overview

Property Details

declaredClass Stringreadonly inherited

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

devices Collection<GamepadInputDevice>readonly

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 String

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 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.

Possible Values:"document"|"view"|"none"

Default Value:document