Class Keyboard

A base class for creating chips that reduces boilerplate code. To use it, simply override some or all of the following protected methods:

  • _onActivate()
  • _onTick()
  • _onTerminate()
  • _onPause()
  • _onResume() In these methods, you can access the _chipContext _lastTickInfo properties to obtain the latest information there.

In addition, you can subscribe to events using _subscribe() in a way that automatically unsubscribes when the chip is terminated.

Hierarchy (view full)

Constructors

constructor

Properties

_chipContext _elapsedTime _eventListeners _inputSignal _lastKeysDown _lastTickInfo _outputSignal _reloadMemento? _state emitter keysDown keysJustDown keysJustUp prefixed

Accessors

children chipContext outputSignal state

Methods

_makeReloadMementoData _onActivate _onFocusOut _onKeyDown _onKeyUp _onPause _onResume _onTerminate _onTick _subscribe _subscribeOnce _unsubscribe activate addListener emit eventNames listenerCount listeners makeReloadMemento off on once pause removeAllListeners removeListener resume terminate tick

Constructors

constructor

Properties

Protected _chipContext

_chipContext: Readonly<Record<string, any>>

Private _elapsedTime

_elapsedTime: number

Protected _eventListeners

_eventListeners: IEventListener[] = []

Protected _inputSignal

_inputSignal: Signal

Private _lastKeysDown

_lastKeysDown: {
    [key: string]: number;
} = {}

Type declaration

  • [key: string]: number

Protected _lastTickInfo

_lastTickInfo: TickInfo

Protected _outputSignal

_outputSignal: Signal

Protected Optional _reloadMemento

_reloadMemento?: ReloadMemento

Protected _state

_state: ChipState = "inactive"

Readonly emitter

emitter: EventTarget

keysDown

keysDown: {
    [key: string]: number;
} = {}

Type declaration

  • [key: string]: number

keysJustDown

keysJustDown: {
    [key: string]: boolean;
} = {}

Type declaration

  • [key: string]: boolean

keysJustUp

keysJustUp: {
    [key: string]: boolean;
} = {}

Type declaration

  • [key: string]: boolean

Static prefixed

prefixed: string | boolean

Accessors

children

  • get children(): Record<string, Chip>

  • Children of this chip, if any

    Returns Record<string, Chip>

chipContext

  • get chipContext(): Readonly<Record<string, any>>

  • Returns Readonly<Record<string, any>>

outputSignal

  • get outputSignal(): Signal

  • Once the chip is terminated, contains the signal

    Returns Signal

state

Methods

Protected _makeReloadMementoData

_onActivate

_onFocusOut

_onKeyDown

  • _onKeyDown(event): void

  • Parameters

    • event: KeyboardEvent

    Returns void

_onKeyUp

  • _onKeyUp(event): void

  • Parameters

    • event: KeyboardEvent

    Returns void

Protected _onPause

Protected _onResume

Protected _onTerminate

_onTick

Protected _subscribe

  • _subscribe(emitter, event, cb, subscriptionHandler?): void

  • Start listening to events of a certain type emitted by an object. The callback will be called with the chip as this. Works by default for both NodeJS- and DOM-style events. If you are interfacing with a different event system, you can provide a subscriptionHandler that knows how to handle it.

    Parameters

    • emitter: object
    • event: string
    • cb: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional subscriptionHandler: SubscriptionHandler

    Returns void

Protected _subscribeOnce

  • _subscribeOnce(emitter, event, cb, subscriptionHandler?): void

  • Listen to a single event emitted by an object, then stop. The callback will be called with the chip as this. Works by default for both NodeJS- and DOM-style events. If you are interfacing with a different event system, you can provide a subscriptionHandler that knows how to handle them.

    Parameters

    • emitter: object
    • event: string
    • cb: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional subscriptionHandler: SubscriptionHandler

    Returns void

Protected _unsubscribe

  • _unsubscribe(emitter?, event?, cb?): void

  • Unsubscribe to a set of events. By default, unsubscribes to everything. If emitter, event, or cb is provided, unsubscribe only to those.

    Parameters

    • Optional emitter: object
    • Optional event: string
    • Optional cb: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: unknown[]

          Returns void

    Returns void

activate

  • activate(tickInfo, chipContext, inputSignal, reloadMemento?): void

  • Activate the chip, with a provided context and input signal. Should only be called from an inactive state

    Parameters

    Returns void

addListener

  • addListener<T>(event, fn, context?): this

  • Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any

    Returns this

emit

  • emit<T>(event, ...args): boolean

  • Calls each of the listeners registered for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Return an array listing the events for which the emitter has registered listeners.

    Returns (string | symbol)[]

listenerCount

  • listenerCount(event): number

  • Return the number of listeners listening to a given event.

    Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners<T>(event): ((...args) => void)[]

  • Return the listeners registered for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T

    Returns ((...args) => void)[]

makeReloadMemento

off

  • off<T>(event, fn?, context?, once?): this

  • Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • Optional fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any
    • Optional once: boolean

    Returns this

on

  • on<T>(event, fn, context?): this

  • Add a listener for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any

    Returns this

once

  • once<T>(event, fn, context?): this

  • Add a one-time listener for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any

    Returns this

pause

  • pause(tickInfo): void

  • Pause the chip, informing it that it won't receive ticks for a while

    Parameters

    Returns void

removeAllListeners

  • removeAllListeners(event?): this

  • Remove all listeners, or those of the specified event.

    Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener<T>(event, fn?, context?, once?): this

  • Remove the listeners of a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • Optional fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any
    • Optional once: boolean

    Returns this

resume

terminate

  • terminate(outputSignal?): void

  • Terminate the chip. Should only be called from an active or paused state

    Parameters

    Returns void

tick

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc