Skip to content
ClassInput & Controls@public

Input ​

Deterministic named digital-input state machine.

ts
export declare class Input

Properties ​

PropertyModifiersTypeDescription
lookupreadonlyMap<string, number>-

Methods ​

addAlias() ​

ts
protected addAlias(alias: string, keyName: string): void

Parameters:

ParameterTypeDescription
aliasstring-
keyNamestring-

Returns: void

addKey() ​

ts
protected addKey(keyName: string, keyCode: number): void

Parameters:

ParameterTypeDescription
keyNamestring-
keyCodenumber-

Returns: void

any() ​

ts
any(): boolean

Returns: boolean

destroy() ​

ts
destroy(): void

Returns: void

getKeyCode() ​

ts
getKeyCode(keyName: string): number

Parameters:

ParameterTypeDescription
keyNamestring-

Returns: number

hasKeyCode() ​

ts
protected hasKeyCode(keyCode: number): boolean

Parameters:

ParameterTypeDescription
keyCodenumber-

Returns: boolean

justPressed() ​

ts
justPressed(key: string): boolean

Parameters:

ParameterTypeDescription
keystring-

Returns: boolean

justReleased() ​

ts
justReleased(key: string): boolean

Parameters:

ParameterTypeDescription
keystring-

Returns: boolean

playback() ​

ts
playback(record: readonly FlxKeyRecord[] | null): void

Parameters:

ParameterTypeDescription
recordreadonly FlxKeyRecord[] | null-

Returns: void

pressed() ​

ts
pressed(key: string): boolean

Parameters:

ParameterTypeDescription
keystring-

Returns: boolean

queueKeyCode() ​

ts
protected queueKeyCode(keyCode: number, down: boolean): void

Parameters:

ParameterTypeDescription
keyCodenumber-
downboolean-

Returns: void

queueReleaseAll() ​

ts
protected queueReleaseAll(): void

Drops unpublished events and queues releases for every published key.

Returns: void

record() ​

ts
record(): FlxKeyRecord[] | null

Returns: FlxKeyRecord[] | null

reset() ​

ts
reset(): void

Returns: void

update() ​

ts
update(): void

Publishes queued transitions for one authoritative simulation step.

Returns: void

Released under the MIT License.