Documentation / @debuffjp/input / Keyboard
Class: Keyboard
Defined in: keyboard.ts:7
Keyboard state by KeyboardEvent.code (layout-independent, e.g. "KeyW", "ArrowLeft", "Space").
Edges (pressed/released) are latched until endStep(), so a tap shorter than a simulation step is never missed. Input calls endStep() for you.
Constructors
Constructor
new Keyboard(
target?):Keyboard
Defined in: keyboard.ts:31
Parameters
target?
Window | HTMLElement = window
Returns
Keyboard
Properties
captured
readonlycaptured:Set<string>
Defined in: keyboard.ts:17
Keys whose browser default (scrolling with arrows/Space, find-as-you-type…) is blocked so an embedded game doesn't move the page. Never applied while the user types in a form field.
Methods
dispose()
dispose():
void
Defined in: keyboard.ts:83
Returns
void
down()
down(
code):boolean
Defined in: keyboard.ts:39
Key is currently held.
Parameters
code
string
Returns
boolean
endStep()
endStep():
void
Defined in: keyboard.ts:71
Clear edges. Call once after each simulation step.
Returns
void
press()
press(
code):void
Defined in: keyboard.ts:54
Simulate a key press (scenarios, tests, on-screen buttons).
Parameters
code
string
Returns
void
pressed()
pressed(
code):boolean
Defined in: keyboard.ts:44
Key went down since the last step.
Parameters
code
string
Returns
boolean
release()
release(
code):void
Defined in: keyboard.ts:61
Simulate a key release.
Parameters
code
string
Returns
void
releaseAll()
releaseAll():
void
Defined in: keyboard.ts:66
Returns
void
released()
released(
code):boolean
Defined in: keyboard.ts:49
Key went up since the last step.
Parameters
code
string
Returns
boolean