Class GameInputs

Hierarchy

Constructors

constructor

Properties

_bindPressCount _keyBindmap _keyStates _pressedDuringMeta _touches allowContextMenu disabled down element filterEvents pointerState pressCount preventDefaults releaseCount state stopPropagation up version

Methods

bind getBindings tick unbind

Constructors

constructor

  • Simple inputs manager to abstract key/mouse inputs.

    Parameters

    Returns GameInputs

Properties

Private _bindPressCount

_bindPressCount: any

Private _keyBindmap

_keyBindmap: any

Private _keyStates

_keyStates: any

Private _pressedDuringMeta

_pressedDuringMeta: any

For a macOs bug workaround

Private _touches

_touches: any

allowContextMenu

allowContextMenu: boolean

When this is false, the context menu will be prevented from opening if there is a binding to the right mouse button.

disabled

disabled: boolean

When disabled, no binding events will fire.

down

down: any

Event emitter for binding press events. The original mouse or key event will be passed as an argument.

element

element: Document | HTMLElement

The HTMLElement that inputs is bound to.

filterEvents

filterEvents: ((ev, bindingName) => boolean)

Type declaration

    • (ev, bindingName): boolean

    • Optional filter function. Useful if you want to, e.g., ignore a key binding if ctrl/alt are pressed, but allow that same binding if it originated from a mouse event.

      Parameters

      • ev: KeyboardEvent & MouseEvent
      • bindingName: string

      Returns boolean

pointerState

pointerState: {
    dx: number;
    dy: number;
    scrollx: number;
    scrolly: number;
    scrollz: number;
}

Numeric counters representing accumulated pointer/scroll inputs since the last time tick was called.

Type declaration

  • dx: number
  • dy: number
  • scrollx: number
  • scrolly: number
  • scrollz: number

pressCount

pressCount: {
    [key: string]: number;
}

How many times each binding has been pressed since the last time tick was called.

Type declaration

  • [key: string]: number

preventDefaults

preventDefaults: boolean

When true, all key events with bindings will call preventDefaults.

releaseCount

releaseCount: {
    [key: string]: number;
}

How many times each binding has been released since the last time tick was called.

Type declaration

  • [key: string]: number

state

state: {
    [key: string]: boolean;
}

The boolean state of whether each binding is currently pressed.

inputs.state['move-left'] // true if a bound key is pressed

Type declaration

  • [key: string]: boolean

stopPropagation

stopPropagation: boolean

When true, all key events with bindings will call stopPropagation.

up

up: any

Event emitter for binding release events. The original mouse or key event will be passed as an argument.

version

version: string

Methods

bind

  • Binds one or more physical keys to an arbitrary binding name. Key strings should align to KeyboardEvent.code strings - e.g. KeyA, ArrowDown, etc.

    `inputs.bind('move-player-left', 'KeyW', 'ArrowLeft')

    Parameters

    • bindingName: string
    • Rest ...keys: string[]

    Returns void

getBindings

  • Returns a copy of all existing bindings, in the format:

      {
         bindingName: [ keyCode1, keyCode2, ... ]
         ...
      }

    Returns {}

    tick

    • Tick function - clears out all cumulative counters

      Returns void

    unbind

    • Removes all key bindings for a given binding name.

      `inputs.unbind('move-player-left')

      Parameters

      • bindingName: any

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc