KeyboardPlugin
Defined in: plugins/KeyboardPlugin.ts:33
Extends
Section titled “Extends”Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new KeyboardPlugin(
id):KeyboardPlugin
Defined in: plugins/Plugin.ts:48
Parameters
Section titled “Parameters”string = 'Plugin'
Returns
Section titled “Returns”KeyboardPlugin
Inherited from
Section titled “Inherited from”Properties
Section titled “Properties”
readonlyid:string='keyboard'
Defined in: plugins/KeyboardPlugin.ts:34
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”onGlobalKeyDown
Section titled “onGlobalKeyDown”onGlobalKeyDown:
Signal<(detail) =>void>
Defined in: plugins/KeyboardPlugin.ts:36
onGlobalKeyUp
Section titled “onGlobalKeyUp”onGlobalKeyUp:
Signal<(detail) =>void>
Defined in: plugins/KeyboardPlugin.ts:37
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get app():
Application
Defined in: plugins/Plugin.ts:52
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”Inherited from
Section titled “Inherited from”enabled
Section titled “enabled”Get Signature
Section titled “Get Signature”get enabled():
boolean
Defined in: plugins/KeyboardPlugin.ts:50
Returns
Section titled “Returns”boolean
Set Signature
Section titled “Set Signature”set enabled(
value):void
Defined in: plugins/KeyboardPlugin.ts:54
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”keysDown
Section titled “keysDown”Get Signature
Section titled “Get Signature”get keysDown():
Set<string>
Defined in: plugins/KeyboardPlugin.ts:44
Returns
Section titled “Returns”Set<string>
Implementation of
Section titled “Implementation of”options
Section titled “options”Get Signature
Section titled “Get Signature”get options():
O
Defined in: plugins/Plugin.ts:44
Returns
Section titled “Returns”O
Implementation of
Section titled “Implementation of”Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”_update()
Section titled “_update()”_update():
void
Defined in: plugins/KeyboardPlugin.ts:85
Returns
Section titled “Returns”void
addSignalConnection()
Section titled “addSignalConnection()”addSignalConnection(…
args):void
Defined in: plugins/Plugin.ts:78
Add signal connections to the container.
Parameters
Section titled “Parameters”…SignalConnection[]
The signal connections to add.
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”IKeyboardPlugin.addSignalConnection
Inherited from
Section titled “Inherited from”clearSignalConnections()
Section titled “clearSignalConnections()”clearSignalConnections():
void
Defined in: plugins/Plugin.ts:84
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”IKeyboardPlugin.clearSignalConnections
Inherited from
Section titled “Inherited from”destroy()
Section titled “destroy()”destroy():
void
Defined in: plugins/KeyboardPlugin.ts:65
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”initialize()
Section titled “initialize()”initialize(
_options,_app):void
Defined in: plugins/KeyboardPlugin.ts:59
Parameters
Section titled “Parameters”_options
Section titled “_options”any
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”isKeyDown()
Section titled “isKeyDown()”isKeyDown(
key):boolean
Defined in: plugins/KeyboardPlugin.ts:81
Parameters
Section titled “Parameters”Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”onKeyDown()
Section titled “onKeyDown()”onKeyDown(
key?):KeySignal
Defined in: plugins/KeyboardPlugin.ts:73
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”onKeyUp()
Section titled “onKeyUp()”onKeyUp(
key?):KeySignal
Defined in: plugins/KeyboardPlugin.ts:77
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”postInitialize()
Section titled “postInitialize()”postInitialize(
_app):void|Promise<void>
Defined in: plugins/Plugin.ts:67
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void | Promise<void>
Implementation of
Section titled “Implementation of”IKeyboardPlugin.postInitialize