Class Keyboard

Keyboard event listener that filters out repeated keydown events and normalizes keycodes to coordinates. The Shift keys toggle 'sustain'.

Index

Constructors

Properties

_keydown? _keyup? activeKeys keydownCallbacks keyupCallbacks log pendingKeys stickyKeys

Methods

addKeydownListener deactivate dispose fireKeydown fireKeyup keydown keyup removeEventListener

Constructors

constructor

new Keyboard(autobind?, log?): Keyboard
Construct a new keyboard event listener.
Parameters
- autobind: boolean = false
  Start listening to "keydown" and "keyup" events immediately.
- Optional log: ((msg) => void)
  Logging function.
  - - (msg): void
    - Parameters
      msg: string
      Returns void
Returns Keyboard
- Defined in keyboard.ts:33

Properties

`Private` `Optional` _keydown

_keydown?: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: KeyboardEvent
  Returns void

`Private` `Optional` _keyup

_keyup?: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: KeyboardEvent
  Returns void

`Private` activeKeys

activeKeys: Set<string>

`Private` keydownCallbacks

keydownCallbacks: KeydownCallback[]

`Private` keyupCallbacks

keyupCallbacks: Map<string, KeyupCallback[]>

`Private` log

log: ((msg) => void)

Type declaration

- (msg): void
- Parameters
  - msg: string
  Returns void

`Private` pendingKeys

pendingKeys: Set<string>

`Private` stickyKeys

stickyKeys: Set<string>

Methods

addKeydownListener

addKeydownListener(listener): void
Register a listener for processed keydown events.
Parameters
- listener: KeydownCallback
  Function to call when a new key is pressed.
Returns void
- Defined in keyboard.ts:71

deactivate

deactivate(): void
Release keys sustained due to being pressed down with 'Shift'.

Returns void
- Defined in keyboard.ts:193

dispose

dispose(): void
Stop listening to "keydown" and "keyup" events if constructed with autobind = true.

Returns void
- Defined in keyboard.ts:58

`Private` fireKeydown

fireKeydown(event): void
Parameters
- event: CoordinateKeyboardEvent
Returns void
- Defined in keyboard.ts:83

`Private` fireKeyup

fireKeyup(event): void
Parameters
- event: CoordinateKeyboardEvent
Returns void
- Defined in keyboard.ts:99

keydown

keydown(event): void
Listener to be registered with window.addEventListener("keydown", ...).
Parameters
- event: KeyboardEvent
  Keyboard event of a key being pressed down.
Returns void
- Defined in keyboard.ts:111

keyup

keyup(event): void
Listener to be registered with window.addEventListener("keyup", ...).
Parameters
- event: KeyboardEvent
  Keyboard event of a pressed key being released.
Returns void
- Defined in keyboard.ts:164

removeEventListener

removeEventListener(listener): void
Unregister a listener for processed keydown events.
Parameters
- listener: KeydownCallback
  Callback registered with Keyboard.addKeydownListener.
Returns void
- Defined in keyboard.ts:79

Generated using TypeDoc