1681-engine / index / Keyboard
Class: Keyboard ​
Defined in: src/input/Keyboard.ts:11
Which keys are held, by KeyboardEvent.code (the physical key, so WASD stays WASD on any layout). pressed and released report edges since the last endStep; call that once per simulation step so a tap shorter than a frame is still seen by exactly one step.
It only knows keys pressed after it was made: a key already held when it is created (the Enter that started a level, held into it) is not down here until it is pressed again. A scene that makes its own keyboard in a field therefore starts with every key up, which is usually what a new screen wants; share one keyboard across scenes when a held key must carry over. Modifier keys are ordinary codes here (ShiftLeft); Actions reads chords from them.
Constructors ​
Constructor ​
new Keyboard(target?): Keyboard;Defined in: src/input/Keyboard.ts:17
Parameters ​
| Parameter | Type | Default value |
|---|---|---|
target | HTMLElement | Window | window |
Returns ​
Keyboard
Methods ​
anyDown() ​
anyDown(...codes): boolean;Defined in: src/input/Keyboard.ts:49
Any of these keys is held.
Parameters ​
| Parameter | Type |
|---|---|
...codes | string[] |
Returns ​
boolean
axis() ​
axis(negative, positive): number;Defined in: src/input/Keyboard.ts:64
-1, 0 or 1 from two sets of keys: axis(['KeyA', 'ArrowLeft'], ['KeyD', 'ArrowRight']).
Parameters ​
| Parameter | Type |
|---|---|
negative | string[] |
positive | string[] |
Returns ​
number
destroy() ​
destroy(): void;Defined in: src/input/Keyboard.ts:74
Returns ​
void
endStep() ​
endStep(): void;Defined in: src/input/Keyboard.ts:69
Forgets this step's edges; held keys stay held.
Returns ​
void
isDown() ​
isDown(code): boolean;Defined in: src/input/Keyboard.ts:44
Parameters ​
| Parameter | Type |
|---|---|
code | string |
Returns ​
boolean
pressed() ​
pressed(code): boolean;Defined in: src/input/Keyboard.ts:54
Went down since the last endStep.
Parameters ​
| Parameter | Type |
|---|---|
code | string |
Returns ​
boolean
released() ​
released(code): boolean;Defined in: src/input/Keyboard.ts:59
Came up since the last endStep.
Parameters ​
| Parameter | Type |
|---|---|
code | string |
Returns ​
boolean