Gamepads

Excalibur leverages the HTML5 Gamepad API where it is supported to provide controller support for your games.

Index

Constructors

• constructor

Properties

• events
• pollingEnabled
• supported
• MinAxisMoveThreshold

Methods

• at
• count
• emit
• getValidGamepads
• init
• off
• on
• once
• setEnabled
• setMinimumGamepadConfiguration
• update

Constructors

constructor

• Gamepads(): Gamepads

• Returns Gamepads

Properties

publicevents

events: EventEmitter<GamepadEvents> = ...

publicpollingEnabled

pollingEnabled: boolean = false

Opt in to polling for Gamepad input (default: false). Independent of the input host switch set by engine.input.setEnabled(), polling only happens when both are on.

publicsupported

supported: boolean = ...

Whether or not Gamepad API is supported

publicstaticMinAxisMoveThreshold

MinAxisMoveThreshold: number = 0.05

The minimum value an axis has to move before considering it a change

Methods

publicat

• at(index: number): Gamepad

• Safely retrieves a Gamepad at a specific index and creates one if it doesn't yet exist

  ---

  Parameters

  • index: number

  Returns Gamepad

publiccount

• count(): number

• Gets the number of connected gamepads

  ---

  Returns number

publicemit

• emit<TEventName>(eventName: TEventName, event: GamepadEvents[TEventName]): void
• emit(eventName: string, event?: any): void

• Type parameters

  • TEventName: EventKey<GamepadEvents>

  Parameters

  • eventName: TEventName

  • event: GamepadEvents[TEventName]

  Returns void

publicgetValidGamepads

• getValidGamepads(): Gamepad[]

• Returns a list of all valid gamepads that meet the minimum configuration requirement.

  ---

  Returns Gamepad[]

publicinit

• init(): void

• Returns void

publicoff

• off<TEventName>(eventName: TEventName, handler: Handler<GamepadEvents[TEventName]>): void
• off(eventName: string, handler: Handler<unknown>): void
• off(eventName: string): void

• Type parameters

  • TEventName: EventKey<GamepadEvents>

  Parameters

  • eventName: TEventName

  • handler: Handler<GamepadEvents[TEventName]>

  Returns void

publicon

• on<TEventName>(eventName: TEventName, handler: Handler<GamepadEvents[TEventName]>): Subscription
• on(eventName: string, handler: Handler<unknown>): Subscription

• Type parameters

  • TEventName: EventKey<GamepadEvents>

  Parameters

  • eventName: TEventName

  • handler: Handler<GamepadEvents[TEventName]>

  Returns Subscription

publiconce

• once<TEventName>(eventName: TEventName, handler: Handler<GamepadEvents[TEventName]>): Subscription
• once(eventName: string, handler: Handler<unknown>): Subscription

• Type parameters

  • TEventName: EventKey<GamepadEvents>

  Parameters

  • eventName: TEventName

  • handler: Handler<GamepadEvents[TEventName]>

  Returns Subscription

publicsetEnabled

• setEnabled(enabled: boolean): void

• Parameters

  • enabled: boolean

  Returns void

publicsetMinimumGamepadConfiguration

• setMinimumGamepadConfiguration(config: GamepadConfiguration): void

• Sets the minimum gamepad configuration, for example {axis: 4, buttons: 4} means this game requires at minimum 4 axis inputs and 4 buttons, this is not restrictive all other controllers with more axis or buttons are valid as well. If no minimum configuration is set all pads are valid.

  ---

  Parameters

  • config: GamepadConfiguration

  Returns void

publicupdate

• update(): void

• Updates Gamepad state and publishes Gamepad events

  ---

  Returns void