Interface KeyboardHandler<Action, Sequence, Events>

The KeyboardHandler manages keyboard based events and translates into game events

interface KeyboardHandler<
    Action = string,
    Sequence = string,
    Events extends EventsMap = NonNullable<unknown>,
> {
    get engine(): Engine<Events, Action, Sequence>;
    actionKeys(action: Action): undefined | KeyData[];
    actionState(action: Action): undefined | HeldState;
    bind(action: Action, ...keys: KeyData[]): this;
    clear(...actions: Action[]): this;
    keyState(key: KeyData): undefined | HeldState;
    register(sequence: Sequence, decay: Chrono, ...keys: KeyData[]): this;
    reset(): this;
    sequenceProgress(sequence: Sequence): number;
    start(): this;
    stop(): this;
    unbind(...keys: KeyData[]): this;
    unregister(...sequences: Sequence[]): this;
}

Type Parameters

Action = string
Sequence = string
Events extends EventsMap = NonNullable<unknown>

Index

Accessors

Methods

actionKeys actionState bind clear keyState register reset sequenceProgress start stop unbind unregister

Accessors

engine

get engine(): Engine<Events, Action, Sequence>
TODO: JSDocs

Returns Engine<Events, Action, Sequence>

Methods

actionKeys

actionKeys(action: Action): undefined | KeyData[]
Get the list of keys that are bound to a given action
Parameters
- action: Action
Returns undefined | KeyData[]

actionState

actionState(action: Action): undefined | HeldState
Get the hold state of a given action
Parameters
- action: Action
Returns undefined | HeldState

bind

bind(action: Action, ...keys: KeyData[]): this
Binds one or more keys to an action
Parameters
- action: Action
- ...keys: KeyData[]
Returns this

clear

clear(...actions: Action[]): this
Removes one or more actions from the handler, including unbinding any associated bound keys
Parameters
- ...actions: Action[]
Returns this

keyState

keyState(key: KeyData): undefined | HeldState
Get the hold state of an action based on a key that may be bound to it
Parameters
- key: KeyData
Returns undefined | HeldState

register

register(sequence: Sequence, decay: Chrono, ...keys: KeyData[]): this
Register a new sequence
Parameters
- sequence: Sequence
- decay: Chrono
- ...keys: KeyData[]
Returns this

reset

reset(): this
Removes all bound keys and registered sequences

Returns this

sequenceProgress

sequenceProgress(sequence: Sequence): number
Get the progress of a given sequence (as a decimal value from 0-100)
Parameters
- sequence: Sequence
Returns number

start

start(): this
Attaches the internal event listener to the global scope to begin processing bound keys and registered sequences

Returns this

stop

stop(): this
Removes the internal event listener from the global scope to stop processing bound keys and registered sequences

Returns this

unbind

unbind(...keys: KeyData[]): this
Removes key binding from one or more keys
Parameters
- ...keys: KeyData[]
Returns this

unregister

unregister(...sequences: Sequence[]): this
Unregister one or more sequences
Parameters
- ...sequences: Sequence[]
Returns this