API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

I

interfaceGamepadMappingData

@codexo/exojs / input / stable

One device layout, as data. This is the whole definition of a controller as far as the engine is concerned - no subclassing is involved, and a custom device is described by writing one of these rather than by extending anything.

5
props
0
methods
0
events
Import
import { GamepadMappingData } from '@codexo/exojs'

One device layout, as data.

This is the whole definition of a controller as far as the engine is concerned - no subclassing is involved, and a custom device is described by writing one of these rather than by extending anything.

Properties5
axes: readonly GamepadAxisSingle mappable analog axis on a physical gamepad. Holds the raw browser `Gamepad.axes[]` index, the canonical channel the value is written to, and the transfo…[]
Axes, addressed by the browser's Gamepad.axes[] index.
buttons: readonly GamepadButtonSingle mappable button on a physical gamepad. Holds the raw browser `Gamepad.buttons[]` index, the canonical channel the value is written to, and the deadzone/…[]
Buttons, addressed by the browser's Gamepad.buttons[] index.
family: GamepadMappingFamilyDevice family a GamepadMapping belongs to. The value a game keys its own button-glyph or controller-artwork set on: `icons[gamepad.family]`. Two devices share…
Device family, for prompt labels and for the game's own artwork selection.
layout?: GamepadMappingLayoutWhich index space a GamepadMapping's button and axis indices live in. Almost every mapping is written against the W3C "standard" layout the browser normalises…
Index space buttons and axes are written against. Defaults to GamepadMappingLayout.Standard.
promptLabels?: ReadonlyMap<GamepadPromptControlNamed controls that can appear in an in-game prompt or button-hint UI. Intentionally a subset of GamepadButton channels - covers the controls a typical prompt…, string>
Prompt labels that differ from this device's family default. A family spans several product generations whose buttons are not all named the same - the PlayStation Select button reads "Select" on a PS3 pad, "Share" on a DualShock 4 and "Create" on a DualSense, yet all three share one family. List only the controls that differ.
Source
src/input/GamepadMapping.ts