RSX Code Reference
    Preparing search index...

    Class Input

    Primary module used for dealing with input. Allows you to receieve and query raw or OS input for mouse/keyboard/gamepad.

    Index
    constructor
    pointerDelta pointerPosition
    getAxisValue isButtonDown isButtonHeld isButtonUp isPointerButtonDown isPointerButtonHeld isPointerButtonUp isPointerDoubleClicked
    onButtonDown onButtonUp onCharInput onPointerMoved onPointerPressed onPointerReleased onPointerDoubleClick onGamepadDeviceAdded onGamepadDeviceRemoved

    • Returns value of the specified input axis. Normally in range [-1.0, 1.0] but can be outside the range for devices with unbound axes (for example mouse).

      Parameters

      • type: number

        Type of axis to query. Usually a type from InputAxis but can be a custom value.

      • OptionaldeviceIndex: number

        Index of the device in case more than one is hooked up (0 - primary).

      Returns number

    • Query if the provided button is currently being pressed (only true for one frame).

      Parameters

      • keyCode: EnumValue<ButtonCode>

        Code of the button to query.

      • OptionaldeviceIndex: number

        Device to query the button on (0 - primary).

      Returns boolean

    • Query if the provided button is currently being held (this frame or previous frames).

      Parameters

      • keyCode: EnumValue<ButtonCode>

        Code of the button to query.

      • OptionaldeviceIndex: number

        Device to query the button on (0 - primary).

      Returns boolean

    • Query if the provided button is currently being released (only true for one frame).

      Parameters

      • keyCode: EnumValue<ButtonCode>

        Code of the button to query.

      • OptionaldeviceIndex: number

        Device to query the button on (0 - primary).

      Returns boolean

    • Query if the provided pointer button is currently being pressed (only true for one frame).

      Parameters

      Returns boolean

    • Query if the provided pointer button is currently being held (this frame or previous frames).

      Parameters

      Returns boolean

    • Query if the provided pointer button is currently being released (only true for one frame).

      Parameters

      Returns boolean

    • Query has the left pointer button has been double-clicked this frame.

      Returns boolean

    onButtonDown: Event<[buttonEvent: ButtonEvent]>

    Triggered whenever a button is first pressed.

    onButtonUp: Event<[buttonEvent: ButtonEvent]>

    Triggered whenever a button is first released.

    onCharInput: Event<[textInputEvent: TextInputEvent]>

    Triggered whenever user inputs a text character.

    onPointerMoved: Event<[pointerEvent: PointerEvent]>

    Triggers when some pointing device (mouse cursor, touch) moves.

    onPointerPressed: Event<[pointerEvent: PointerEvent]>

    Triggers when some pointing device (mouse cursor, touch) button is pressed.

    onPointerReleased: Event<[pointerEvent: PointerEvent]>

    Triggers when some pointing device (mouse cursor, touch) button is released.

    onPointerDoubleClick: Event<[pointerEvent: PointerEvent]>

    Triggers when some pointing device (mouse cursor, touch) button is double clicked.

    onGamepadDeviceAdded: Event<
        [deviceIndex: number, name: string, timestamp: number],
    >

    An event triggered whenever a new gamepad is added.

    onGamepadDeviceRemoved: Event<
        [deviceIndex: number, name: string, timestamp: number],
    >

    An event triggered whenever a new gamepad is removed.

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors
    Methods
    Events