Interface InputAPI

All Known Implementing Classes:
InputModule
public interface InputAPI
Public API definition for the UI module, UiModule.

The UI module contains methods and calls that modify and query the user interface.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    disable()
    Disable all input events in Gaia Sky (mouse, keyboard, touchscreen, and gamepad) until a call to enable() is issued.
    void
    enable()
    Enable all input events in Gaia Sky (mouse, keyboard, touchscreen, and gamepad).
    void
    wait_enter()
    Block the execution until the Enter key is pressed.
    void
    wait_input()
    Block the execution until any kind of input (keyboard, mouse, etc.) is received.
    void
    wait_input(int code)
    Block the execution until the given key or button is pressed.

  • Method Details

    • disable

      void disable()
      Disable all input events in Gaia Sky (mouse, keyboard, touchscreen, and gamepad) until a call to enable() is issued.

      After this method is called, Gaia Sky will not respond to any kind of input event.

    • enable

      void enable()
      Enable all input events in Gaia Sky (mouse, keyboard, touchscreen, and gamepad). This call re-enables all input events, which were possibly disabled with disable().

    • wait_input

      void wait_input()
      Block the execution until any kind of input (keyboard, mouse, etc.) is received.

    • wait_input

      void wait_input(int code)
      Block the execution until the given key or button is pressed.
      Parameters:
      code - The key or button code. Please see Input.Keys and GSKeys.

    • wait_enter

      void wait_enter()
      Block the execution until the Enter key is pressed.