Class VirtualInput

constructor

• new VirtualInput(): VirtualInput

• Returns VirtualInput

Staticconfiguration

• get configuration(): InputConfiguration

• Sets an input configuration that determines how physical keys map to virtual buttons.

  Returns InputConfiguration
• set configuration(value): void

• Parameters

  • value: InputConfiguration

  Returns void

StaticdefaultConfiguration

• get defaultConfiguration(): InputConfiguration

• Retrieves the default input configuration that determines how physical keys map to virtual buttons.

  Returns InputConfiguration

  Note

  Statically registered buttons and axes will be registered with the default configuration. If the active configuration is changed, only procedurally registered buttons and axes will be available.

StaticgetAxisValue

• getAxisValue(virtualAxis, deviceIndex?): number

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

  Parameters

  • virtualAxis: VirtualAxis
  • OptionaldeviceIndex: number

    Optional device index in case multiple input devices are available.

  Returns number

StaticisButtonDown

• isButtonDown(button, deviceIndex?): boolean

• Check is the virtual button just getting pressed. This state is only active for one frame.

  Parameters

  • button: VirtualButton

    Virtual button identifier.
  • OptionaldeviceIndex: number

    Optional device index in case multiple input devices are available.

  Returns boolean

StaticisButtonHeld

• isButtonHeld(button, deviceIndex?): boolean

• Check is the virtual button is being held. This state is active as long as the button is being held down, possibly for multiple frames.

  Parameters

  • button: VirtualButton

    Virtual button identifier.
  • OptionaldeviceIndex: number

    Optional device index in case multiple input devices are available.

  Returns boolean

StaticisButtonUp

• isButtonUp(button, deviceIndex?): boolean

• Check is the virtual button just getting released. This state is only active for one frame.

  Parameters

  • button: VirtualButton

    Virtual button identifier.
  • OptionaldeviceIndex: number

    Optional device index in case multiple input devices are available.

  Returns boolean

Static ReadonlyonButtonDown

Static ReadonlyonButtonUp

Static ReadonlyonButtonHeld