HomeGuidesAPI Reference
HubBlogChangelogSupport ForumLog In
API Reference

Node.js SDK - InputBody

Home > @rainway/native > InputBody

InputBody class

The body of an input event.

Signature:

export declare class InputBody 

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 InputBody class.

Properties

PropertyModifiersTypeDescription
heldKeysRainwayVirtualKey[]The RainwayVirtualKey keys that were held down during this input event.
tagRainwayInput_TagA tag identifying the type of input.

Methods

MethodModifiersDescription
AsGamepadReport()Retrieve the input as a gamepad report.
AsGamepadRumble()Retrieve the input as a gamepad rumble.
AsKeyboardInput()Retrieve the input as a keyboard input.
AsLogicalInput()Retrieve the input as a logical input.
AsMouseAbsolute()Retrieve the input as a mouse absolute.
AsMouseClick()Retrieve the input as a mouse click.
AsMouseRelative()Retrieve the input as a mouse relative.
AsMouseScroll()Retrieve the input as a mouse scroll.
AsPenAbsolute()Retrieve the input as a pen absolute.
AsSetClipboardText()Retrieve the input as clipboard text.
AsTouchesAbsolute()Retrieve the input as a touches absolute.
AsViewportResize()Retrieve the input as a viewport resize.