Home > @rainway/web > HeldKeys
HeldKeys class
An interface for querying which keyboard keys are currently held down (locally, on the web page).
Signature:
export declare class HeldKeys
Remarks
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the HeldKeys class.
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| alt | boolean | Reports whether either Alt key is pressed. | |
| ctrl | boolean | Reports whether either Ctrl key is pressed. | |
| keys | ReadonlySet<VirtualKey> | Returns all held keys as a ReadonlySet. | |
| shift | boolean | Reports whether either Shift key is pressed. | |
| win | boolean | Reports whether either Windows/Meta key is pressed. |
Methods
| Method | Modifiers | Description |
|---|---|---|
| has(key) | Reports whether the given VirtualKey is pressed. |