Skip to content

KeyboardPlugin

Defined in: plugins/KeyboardPlugin.ts:33

Extends

Implements

Constructors

new KeyboardPlugin()

new KeyboardPlugin(id): KeyboardPlugin

Defined in: plugins/Plugin.ts:40

Parameters

id

string = 'Plugin'

Returns

KeyboardPlugin

Inherited from

Plugin.constructor

Properties

__dill_pixel_method_binding_root

__dill_pixel_method_binding_root: boolean

Defined in: plugins/Plugin.ts:37

Inherited from

Plugin.__dill_pixel_method_binding_root


id

readonly id: string = 'keyboard'

Defined in: plugins/KeyboardPlugin.ts:34

Implementation of

IKeyboardPlugin.id

Overrides

Plugin.id


onGlobalKeyDown

onGlobalKeyDown: Signal<(detail) => void>

Defined in: plugins/KeyboardPlugin.ts:36


onGlobalKeyUp

onGlobalKeyUp: Signal<(detail) => void>

Defined in: plugins/KeyboardPlugin.ts:37

Accessors

app

Get Signature

get app(): T

Defined in: plugins/Plugin.ts:45

Returns

T

Implementation of

IKeyboardPlugin.app

Inherited from

Plugin.app


enabled

Get Signature

get enabled(): boolean

Defined in: plugins/KeyboardPlugin.ts:50

Returns

boolean

Set Signature

set enabled(value): void

Defined in: plugins/KeyboardPlugin.ts:54

Parameters
value

boolean

Returns

void

Implementation of

IKeyboardPlugin.enabled


keysDown

Get Signature

get keysDown(): Set<string>

Defined in: plugins/KeyboardPlugin.ts:44

Returns

Set<string>

Implementation of

IKeyboardPlugin.keysDown

Methods

_update()

_update(): void

Defined in: plugins/KeyboardPlugin.ts:85

Returns

void


addSignalConnection()

addSignalConnection(…args): void

Defined in: plugins/Plugin.ts:71

Add signal connections to the container.

Parameters

args

SignalConnection[]

The signal connections to add.

Returns

void

Implementation of

IKeyboardPlugin.addSignalConnection

Inherited from

Plugin.addSignalConnection


clearSignalConnections()

clearSignalConnections(): void

Defined in: plugins/Plugin.ts:77

Returns

void

Implementation of

IKeyboardPlugin.clearSignalConnections

Inherited from

Plugin.clearSignalConnections


destroy()

destroy(): void

Defined in: plugins/KeyboardPlugin.ts:65

Returns

void

Implementation of

IKeyboardPlugin.destroy

Overrides

Plugin.destroy


initialize()

initialize(_app): void

Defined in: plugins/KeyboardPlugin.ts:59

Parameters

_app

IApplication

Returns

void

Implementation of

IKeyboardPlugin.initialize

Overrides

Plugin.initialize


isKeyDown()

isKeyDown(key): boolean

Defined in: plugins/KeyboardPlugin.ts:81

Parameters

key

KeyboardKey

Returns

boolean

Implementation of

IKeyboardPlugin.isKeyDown


onKeyDown()

onKeyDown(key?): KeySignal

Defined in: plugins/KeyboardPlugin.ts:73

Parameters

key?

KeyboardKey

Returns

KeySignal

Implementation of

IKeyboardPlugin.onKeyDown


onKeyUp()

onKeyUp(key?): KeySignal

Defined in: plugins/KeyboardPlugin.ts:77

Parameters

key?

KeyboardKey

Returns

KeySignal

Implementation of

IKeyboardPlugin.onKeyUp


postInitialize()

postInitialize(_app): void | Promise<void>

Defined in: plugins/Plugin.ts:60

Parameters

_app

IApplication

Returns

void | Promise<void>

Implementation of

IKeyboardPlugin.postInitialize

Inherited from

Plugin.postInitialize