Class XboxGamepad

XboxGamepad class represents an Xbox gamepad device. It provides named events and methods for Xbox-specific buttons and controls.

Hierarchy (View Summary)

GamepadDevice
- XboxGamepad

Index

Constructors

constructor

new XboxGamepad(gamepad: Gamepad): XboxGamepad
Parameters
- gamepad: Gamepad
Returns XboxGamepad
Overrides GamepadDevice.constructor
- Defined in Extensions/InputSystem/Gamepads/XboxGamepad.ts:87

Properties

`Protected`gamepad

gamepad: Gamepad

`Readonly`onAButtonDown

onAButtonDown: Event<void> = ...

`Readonly`onAButtonUp

onAButtonUp: Event<void> = ...

`Readonly`onAnyChange

onAnyChange: Event<void> = ...

onAnyButtonPress is an event that is triggered when any device button is pressed. Add observers and emit the event.

`Readonly`onAxisChange

onAxisChange: Event<{ index: number; value: Vector2 }> = ...

Event emitted when any axis is changed with the index of the axis and the value of the axis.

`Readonly`onBackButtonDown

onBackButtonDown: Event<void> = ...

`Readonly`onBackButtonUp

onBackButtonUp: Event<void> = ...

`Readonly`onBButtonDown

onBButtonDown: Event<void> = ...

`Readonly`onBButtonUp

onBButtonUp: Event<void> = ...

`Readonly`onButtonDown

onButtonDown: Event<number> = ...

Event emitted when any button is pressed down with the index of the button.

`Readonly`onButtonUp

onButtonUp: Event<number> = ...

Event emitted when any button is released with the index of the button.

`Readonly`onDPadDownDown

onDPadDownDown: Event<void> = ...

`Readonly`onDPadDownUp

onDPadDownUp: Event<void> = ...

`Readonly`onDPadLeftDown

onDPadLeftDown: Event<void> = ...

`Readonly`onDPadLeftUp

onDPadLeftUp: Event<void> = ...

`Readonly`onDPadRightDown

onDPadRightDown: Event<void> = ...

`Readonly`onDPadRightUp

onDPadRightUp: Event<void> = ...

`Readonly`onDPadUpDown

onDPadUpDown: Event<void> = ...

`Readonly`onDPadUpUp

onDPadUpUp: Event<void> = ...

`Readonly`onLeftBumperDown

onLeftBumperDown: Event<void> = ...

`Readonly`onLeftBumperUp

onLeftBumperUp: Event<void> = ...

`Readonly`onLeftStickButtonDown

onLeftStickButtonDown: Event<void> = ...

`Readonly`onLeftStickButtonUp

onLeftStickButtonUp: Event<void> = ...

`Readonly`onLeftStickChange

onLeftStickChange: Event<Vector2> = ...

`Readonly`onLeftTriggerChange

onLeftTriggerChange: Event<number> = ...

`Readonly`onRightBumperDown

onRightBumperDown: Event<void> = ...

`Readonly`onRightBumperUp

onRightBumperUp: Event<void> = ...

`Readonly`onRightStickButtonDown

onRightStickButtonDown: Event<void> = ...

`Readonly`onRightStickButtonUp

onRightStickButtonUp: Event<void> = ...

`Readonly`onRightStickChange

onRightStickChange: Event<Vector2> = ...

`Readonly`onRightTriggerChange

onRightTriggerChange: Event<number> = ...

`Readonly`onStartButtonDown

onStartButtonDown: Event<void> = ...

`Readonly`onStartButtonUp

onStartButtonUp: Event<void> = ...

`Readonly`onXboxButtonDown

onXboxButtonDown: Event<void> = ...

`Readonly`onXboxButtonUp

onXboxButtonUp: Event<void> = ...

`Readonly`onXButtonDown

onXButtonDown: Event<void> = ...

`Readonly`onXButtonUp

onXButtonUp: Event<void> = ...

`Readonly`onYButtonDown

onYButtonDown: Event<void> = ...

`Readonly`onYButtonUp

onYButtonUp: Event<void> = ...

`Static` `Readonly`BUTTON_A

BUTTON_A: 0

`Static` `Readonly`BUTTON_B

BUTTON_B: 1

`Static` `Readonly`BUTTON_BACK

BUTTON_BACK: 8

`Static` `Readonly`BUTTON_DPAD_DOWN

BUTTON_DPAD_DOWN: 13

`Static` `Readonly`BUTTON_DPAD_LEFT

BUTTON_DPAD_LEFT: 14

`Static` `Readonly`BUTTON_DPAD_RIGHT

BUTTON_DPAD_RIGHT: 15

`Static` `Readonly`BUTTON_DPAD_UP

BUTTON_DPAD_UP: 12

`Static` `Readonly`BUTTON_LB

BUTTON_LB: 4

`Static` `Readonly`BUTTON_LEFT_STICK

BUTTON_LEFT_STICK: 10

`Static` `Readonly`BUTTON_LT

BUTTON_LT: 6

`Static` `Readonly`BUTTON_RB

BUTTON_RB: 5

`Static` `Readonly`BUTTON_RIGHT_STICK

BUTTON_RIGHT_STICK: 11

`Static` `Readonly`BUTTON_RT

BUTTON_RT: 7

`Static` `Readonly`BUTTON_START

BUTTON_START: 9

`Static` `Readonly`BUTTON_X

BUTTON_X: 2

`Static` `Readonly`BUTTON_XBOX

BUTTON_XBOX: 16

`Static` `Readonly`BUTTON_Y

BUTTON_Y: 3

`Static` `Readonly`DEAD_ZONE

DEAD_ZONE: number = 0.1

Accessors

index

get index(): number
Get the index of the gamepad

Returns number
Inherited from GamepadDevice.index
- Defined in Extensions/InputSystem/GamepadDevice.ts:50

Methods

pollGamepadOnce

pollGamepadOnce(freshGamepad: Gamepad): void
Updates the gamepad state with fresh data and emits events for changes
Parameters
- freshGamepad: Gamepad
  The fresh gamepad state from GamepadManager
Returns void
Overrides GamepadDevice.pollGamepadOnce
- Defined in Extensions/InputSystem/Gamepads/XboxGamepad.ts:224

Class XboxGamepad

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns XboxGamepad

Properties

Protectedgamepad

ReadonlyonAButtonDown

ReadonlyonAButtonUp

ReadonlyonAnyChange

ReadonlyonAxisChange

ReadonlyonBackButtonDown

ReadonlyonBackButtonUp

ReadonlyonBButtonDown

ReadonlyonBButtonUp

ReadonlyonButtonDown

ReadonlyonButtonUp

ReadonlyonDPadDownDown

ReadonlyonDPadDownUp

ReadonlyonDPadLeftDown

ReadonlyonDPadLeftUp

ReadonlyonDPadRightDown

ReadonlyonDPadRightUp

ReadonlyonDPadUpDown

ReadonlyonDPadUpUp

ReadonlyonLeftBumperDown

ReadonlyonLeftBumperUp

ReadonlyonLeftStickButtonDown

ReadonlyonLeftStickButtonUp

ReadonlyonLeftStickChange

ReadonlyonLeftTriggerChange

ReadonlyonRightBumperDown

ReadonlyonRightBumperUp

ReadonlyonRightStickButtonDown

ReadonlyonRightStickButtonUp

ReadonlyonRightStickChange

ReadonlyonRightTriggerChange

ReadonlyonStartButtonDown

ReadonlyonStartButtonUp

ReadonlyonXboxButtonDown

ReadonlyonXboxButtonUp

ReadonlyonXButtonDown

ReadonlyonXButtonUp

ReadonlyonYButtonDown

ReadonlyonYButtonUp

Static ReadonlyBUTTON_A

Static ReadonlyBUTTON_B

Static ReadonlyBUTTON_BACK

Static ReadonlyBUTTON_DPAD_DOWN

Static ReadonlyBUTTON_DPAD_LEFT

Static ReadonlyBUTTON_DPAD_RIGHT

Static ReadonlyBUTTON_DPAD_UP

Static ReadonlyBUTTON_LB

Static ReadonlyBUTTON_LEFT_STICK

Static ReadonlyBUTTON_LT

Static ReadonlyBUTTON_RB

Static ReadonlyBUTTON_RIGHT_STICK

Static ReadonlyBUTTON_RT

Static ReadonlyBUTTON_START

Static ReadonlyBUTTON_X

Static ReadonlyBUTTON_XBOX

Static ReadonlyBUTTON_Y

Static ReadonlyDEAD_ZONE

Accessors

index

Returns number

Methods

pollGamepadOnce

Parameters

Returns void

Settings

On This Page

`Protected`gamepad

`Readonly`onAButtonDown

`Readonly`onAButtonUp

`Readonly`onAnyChange

`Readonly`onAxisChange

`Readonly`onBackButtonDown

`Readonly`onBackButtonUp

`Readonly`onBButtonDown

`Readonly`onBButtonUp

`Readonly`onButtonDown

`Readonly`onButtonUp

`Readonly`onDPadDownDown

`Readonly`onDPadDownUp

`Readonly`onDPadLeftDown

`Readonly`onDPadLeftUp

`Readonly`onDPadRightDown

`Readonly`onDPadRightUp

`Readonly`onDPadUpDown

`Readonly`onDPadUpUp

`Readonly`onLeftBumperDown

`Readonly`onLeftBumperUp

`Readonly`onLeftStickButtonDown

`Readonly`onLeftStickButtonUp

`Readonly`onLeftStickChange

`Readonly`onLeftTriggerChange

`Readonly`onRightBumperDown

`Readonly`onRightBumperUp

`Readonly`onRightStickButtonDown

`Readonly`onRightStickButtonUp

`Readonly`onRightStickChange

`Readonly`onRightTriggerChange

`Readonly`onStartButtonDown

`Readonly`onStartButtonUp

`Readonly`onXboxButtonDown

`Readonly`onXboxButtonUp

`Readonly`onXButtonDown

`Readonly`onXButtonUp

`Readonly`onYButtonDown

`Readonly`onYButtonUp

`Static` `Readonly`BUTTON_A

`Static` `Readonly`BUTTON_B

`Static` `Readonly`BUTTON_BACK

`Static` `Readonly`BUTTON_DPAD_DOWN

`Static` `Readonly`BUTTON_DPAD_LEFT

`Static` `Readonly`BUTTON_DPAD_RIGHT

`Static` `Readonly`BUTTON_DPAD_UP

`Static` `Readonly`BUTTON_LB

`Static` `Readonly`BUTTON_LEFT_STICK

`Static` `Readonly`BUTTON_LT

`Static` `Readonly`BUTTON_RB

`Static` `Readonly`BUTTON_RIGHT_STICK

`Static` `Readonly`BUTTON_RT

`Static` `Readonly`BUTTON_START

`Static` `Readonly`BUTTON_X

`Static` `Readonly`BUTTON_XBOX

`Static` `Readonly`BUTTON_Y

`Static` `Readonly`DEAD_ZONE