HomeGuidesAPI Reference
HubBlogChangelogSupport ForumLog In
API Reference

Web SDK - HeldKeys

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 

Properties

PropertyModifiersTypeDescription
altreadonlybooleanReports whether either Alt key is pressed.
ctrlreadonlybooleanReports whether either Ctrl key is pressed.
keysreadonlyReadonlySet<VirtualKey>Returns all held keys as a ReadonlySet.
shiftreadonlybooleanReports whether either Shift key is pressed.
winreadonlybooleanReports whether either Windows/Meta key is pressed.

Methods

MethodModifiersDescription
has(key)Reports whether the given VirtualKey is pressed.