Class KeyboardHandler

Represents a global keyboard. Will likely only create one per app.

You can bind/switch KeyboardContexts to the Keyboard handler to change input 'modes'.

Hierarchy

KeyboardHandler

Index

Constructors

constructor

Methods

Constructors

constructor

new KeyboardHandler(config?: undefined | { stopPropagation: boolean }): KeyboardHandler

- Defined in input/keyboard.ts:26
Creates a new KeyboardHandler

Parameters
- Optional config: undefined | { stopPropagation: boolean }
Returns KeyboardHandler

Methods

clearContext

clearContext(): KeyboardContext | undefined

- Defined in input/keyboard.ts:85
Clears the active context for the keyboard handler.

Returns KeyboardContext | undefined

isKeyDown

isKeyDown(keyCode: number): boolean

- Defined in input/keyboard.ts:95
Returns if a key is currently held down.

Parameters
- keyCode: number
  
  KeyCode | number - The keyCode to check
Returns boolean

setContext

setContext(context: KeyboardContext): void

- Defined in input/keyboard.ts:78
Sets the active context of the keyboard handler.

Parameters
- context: KeyboardContext
  
  KeyboardContext - The context to use
Returns void

waitForKeyDown

waitForKeyDown(keyCode?: undefined | number): Promise<number>

- Defined in input/keyboard.ts:123
Returns a promise that will resolve the next time a given keyCode is pressed down. If no keyCode is given, it will return the next keyCode pressed.

Parameters
- Optional keyCode: undefined | number
Returns Promise<number>
- The pressed keyCode.

waitForKeyUp

waitForKeyUp(keyCode?: undefined | number): Promise<number>

- Defined in input/keyboard.ts:105
Returns a promise that will resolve the next time a given keyCode is released. If no keyCode is given, it will return the next keyCode released.

Parameters
- Optional keyCode: undefined | number
  
  The keyCode to listen to. If not provided, will monitor for any keycode.
Returns Promise<number>
- The pressed keyCode.

Generated using TypeDoc