Class Input

constructor

• new Input(): Input

• Returns Input

StaticpointerDelta

• get pointerDelta(): Immutable<Vector2>

• Returns difference between pointer position between current and last frame.

  Returns Immutable<Vector2>

StaticpointerPosition

• get pointerPosition(): Immutable<Vector2>

• Returns position of the pointer (for example mouse cursor) relative to the screen.

  Returns Immutable<Vector2>

StaticgetAxisValue

• getAxisValue(type, deviceIndex?): number

• 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

StaticisButtonDown

• isButtonDown(keyCode, deviceIndex?): boolean

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

  Parameters

  • keyCode: EnumValue<ButtonCode, number>

    Code of the button to query.
  • OptionaldeviceIndex: number

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

  Returns boolean

StaticisButtonHeld

• isButtonHeld(keyCode, deviceIndex?): boolean

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

  Parameters

  • keyCode: EnumValue<ButtonCode, number>

    Code of the button to query.
  • OptionaldeviceIndex: number

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

  Returns boolean

StaticisButtonUp

• isButtonUp(keyCode, deviceIndex?): boolean

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

  Parameters

  • keyCode: EnumValue<ButtonCode, number>

    Code of the button to query.
  • OptionaldeviceIndex: number

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

  Returns boolean

StaticisPointerButtonDown

• isPointerButtonDown(pointerButton): boolean

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

  Parameters

  • pointerButton: EnumValue<PointerButton, number>

    Code of the button to query.

  Returns boolean

StaticisPointerButtonHeld

• isPointerButtonHeld(pointerButton): boolean

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

  Parameters

  • pointerButton: EnumValue<PointerButton, number>

    Code of the button to query.

  Returns boolean

StaticisPointerButtonUp

• isPointerButtonUp(pointerButton): boolean

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

  Parameters

  • pointerButton: EnumValue<PointerButton, number>

    Code of the button to query.

  Returns boolean

StaticisPointerDoubleClicked

• isPointerDoubleClicked(): boolean

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

  Returns boolean

Static ReadonlyonButtonDown

Static ReadonlyonButtonUp

Static ReadonlyonCharInput

Static ReadonlyonPointerMoved

Static ReadonlyonPointerPressed

Static ReadonlyonPointerReleased

Static ReadonlyonPointerDoubleClick

Static ReadonlyonGamepadDeviceAdded

Static ReadonlyonGamepadDeviceRemoved