Class Gamepad

Gamepad holds state information for a connected controller. See Gamepads for more information on handling controller input.

Hierarchy

Gamepad

Index

Constructors

constructor

new Gamepad(): Gamepad
Returns Gamepad
- Defined in Input/Gamepad.ts:290

Properties

connected

connected: boolean = false

events

events: EventEmitter<GamepadEvents> = ...

navigatorGamepad

navigatorGamepad: NavigatorGamepad

Methods

emit

emit<TEventName>(eventName: TEventName, event: GamepadEvents[TEventName]): void
Type Parameters
- TEventName extends EventKey<GamepadEvents>
Parameters
- eventName: TEventName
- event: GamepadEvents[TEventName]
Returns void
- Defined in Input/Gamepad.ts:383
emit(eventName: string, event?: any): void
Parameters
- eventName: string
- Optional event: any
Returns void
- Defined in Input/Gamepad.ts:384

getAxes

getAxes(axes: Axes): number
Gets the given axis value between -1 and 1. Values below MinAxisMoveThreshold are considered 0.
Parameters
- axes: Axes
Returns number
- Defined in Input/Gamepad.ts:356

getButton

getButton(button: Buttons): number
Gets the given button value between 0 and 1
Parameters
- button: Buttons
Returns number
- Defined in Input/Gamepad.ts:348

isButtonHeld

isButtonHeld(button: Buttons, threshold?: number): boolean
Tests if a certain button is held down. This is persisted between frames.
Parameters
- button: Buttons
  
  The button to query
- threshold: number = 1
  
  The threshold over which the button is considered to be pressed
Returns boolean
- Defined in Input/Gamepad.ts:322

isButtonPressed

isButtonPressed(button: Buttons, threshold?: number): boolean
Whether or not the given button is pressed

Deprecated
will be removed in v0.28.0. Use isButtonHeld instead
Parameters
- button: Buttons
  
  The button to query
- threshold: number = 1
  
  The threshold over which the button is considered to be pressed
Returns boolean
- Defined in Input/Gamepad.ts:312

off

off<TEventName>(eventName: TEventName, handler: Handler<GamepadEvents[TEventName]>): void
Type Parameters
- TEventName extends EventKey<GamepadEvents>
Parameters
- eventName: TEventName
- handler: Handler<GamepadEvents[TEventName]>
Returns void
- Defined in Input/Gamepad.ts:401
off(eventName: string, handler: Handler<unknown>): void
Parameters
- eventName: string
- handler: Handler<unknown>
Returns void
- Defined in Input/Gamepad.ts:402
off(eventName: string): void
Parameters
- eventName: string
Returns void
- Defined in Input/Gamepad.ts:403

on

on<TEventName>(eventName: TEventName, handler: Handler<GamepadEvents[TEventName]>): Subscription
Type Parameters
- TEventName extends EventKey<GamepadEvents>
Parameters
- eventName: TEventName
- handler: Handler<GamepadEvents[TEventName]>
Returns Subscription
- Defined in Input/Gamepad.ts:389
on(eventName: string, handler: Handler<unknown>): Subscription
Parameters
- eventName: string
- handler: Handler<unknown>
Returns Subscription
- Defined in Input/Gamepad.ts:390

once

once<TEventName>(eventName: TEventName, handler: Handler<GamepadEvents[TEventName]>): Subscription
Type Parameters
- TEventName extends EventKey<GamepadEvents>
Parameters
- eventName: TEventName
- handler: Handler<GamepadEvents[TEventName]>
Returns Subscription
- Defined in Input/Gamepad.ts:395
once(eventName: string, handler: Handler<unknown>): Subscription
Parameters
- eventName: string
- handler: Handler<unknown>
Returns Subscription
- Defined in Input/Gamepad.ts:396

update

update(): void
Returns void
- Defined in Input/Gamepad.ts:299

updateAxes

updateAxes(axesIndex: number, value: number): void
Parameters
- axesIndex: number
- value: number
Returns void
- Defined in Input/Gamepad.ts:379

updateButton

updateButton(buttonIndex: number, value: number): void
Parameters
- buttonIndex: number
- value: number
Returns void
- Defined in Input/Gamepad.ts:366

wasButtonPressed

wasButtonPressed(button: Buttons, threshold?: number): boolean
Tests if a certain button was just pressed this frame. This is cleared at the end of the update frame.
Parameters
- button: Buttons
  
  Test whether a button was just pressed
- threshold: number = 1
  
  The threshold over which the button is considered to be pressed
Returns boolean
- Defined in Input/Gamepad.ts:332

wasButtonReleased

wasButtonReleased(button: Buttons): boolean
Tests if a certain button was just released this frame. This is cleared at the end of the update frame.
Parameters
- button: Buttons
  
  Test whether a button was just released
Returns boolean
- Defined in Input/Gamepad.ts:341

Class Gamepad

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Gamepad

Properties

connected

events

navigatorGamepad

Methods

emit

Type Parameters

TEventName extends EventKey<GamepadEvents>

Parameters

eventName: TEventName

event: GamepadEvents[TEventName]

Returns void

Parameters

eventName: string

Optional event: any

Returns void

getAxes

Parameters

axes: Axes

Returns number

getButton

Parameters

button: Buttons

Returns number

isButtonHeld

Parameters

button: Buttons

threshold: number = 1

Returns boolean

isButtonPressed

Deprecated

Parameters

button: Buttons

threshold: number = 1

Returns boolean

off

Type Parameters

TEventName extends EventKey<GamepadEvents>

Parameters

eventName: TEventName

handler: Handler<GamepadEvents[TEventName]>

Returns void

Parameters

eventName: string

handler: Handler<unknown>

Returns void

Parameters

eventName: string

Returns void

on

Type Parameters

TEventName extends EventKey<GamepadEvents>

Parameters

eventName: TEventName

handler: Handler<GamepadEvents[TEventName]>

Returns Subscription

Parameters

eventName: string

handler: Handler<unknown>

Returns Subscription

once

Type Parameters

TEventName extends EventKey<GamepadEvents>

Parameters

eventName: TEventName

handler: Handler<GamepadEvents[TEventName]>

Returns Subscription

Parameters

eventName: string

handler: Handler<unknown>

Returns Subscription

`Optional` event: any