The Cursor module changes the mouse cursor settings. Currently, it only supports changing the visibility and lock state of the cursor.

🖱️ Settings

The cursor settings are defined for an enabled state and a disabled state. For example, when a UI menu is opened, the cursor module can be disabled to show the cursor when normally it would be hidden. The following settings are available to customize for each state:

  • Lock Mode: How the cursor should behave:

    • None: Cursor behavior is unmodified.
    • Locked: Lock the cursor to the center of the game window.
    • Confined: Confines the cursor to the game window.
  • Visible: Shows or hides the cursor.

🧰 Scripting API