API reference

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

C

classGamepadMapping

@codexo/exojs / input / stable

Translation layer between the browser's raw Gamepad API indices and ExoJS-canonical input channels. The engine selects one when a gamepad connects (see `GamepadDefinition`) and uses it to route raw values to the correct channels every frame. Construct one from GamepadMappingData to describe a device the built-in definitions do not cover.

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

Translation layer between the browser's raw Gamepad API indices and ExoJS-canonical input channels.

The engine selects one when a gamepad connects (see `GamepadDefinition`) and uses it to route raw values to the correct channels every frame. Construct one from GamepadMappingData to describe a device the built-in definitions do not cover.

Constructors1
new(data: GamepadMappingDataOne 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…): GamepadMapping
Methods1
hasChannel(channel: GamepadAxisChannelBranded literal-union type identifying a canonical analog axis-style gamepad input channel. Members are absolute offsets into the engine's shared Float32Array… | GamepadButtonChannelBranded literal-union type identifying a canonical button-style gamepad input channel. Members are absolute offsets into the engine's shared Float32Array input…): boolean
Returns true when this mapping declares at least one button or axis control that writes to channel. Use to detect device-specific capabilities at runtime - e.g. before binding an input to a right-stick channel that may not exist on a single Joy-Con.
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…[]
Ordered list of axes, indexed by the Gamepad API axis 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/…[]
Ordered list of buttons, indexed by the Gamepad API button 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…
Identifies the device family this mapping targets.
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 this mapping's button and axis indices are written against.
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> | undefined
Device-specific prompt labels - see GamepadMappingData.promptLabels.
Source
src/input/GamepadMapping.ts