This no longer confines the mouse to the window. This was an annoying issue where the mouse could never leave the game when in windowed mode. The mouse is still confined when playing the game with the mouse and unconfined when in the menu.

Author: SimonC4

main/res/imgs/cursorHidden.png

@@ -4,13 +4,15 @@
 import com.badlogic.gdx.audio.Sound;
 import com.badlogic.gdx.files.FileHandle;
 import com.badlogic.gdx.graphics.Color;
+import com.badlogic.gdx.graphics.Pixmap;
 import com.badlogic.gdx.graphics.g2d.TextureAtlas;
 import com.badlogic.gdx.math.Rectangle;
 import com.badlogic.gdx.math.Vector2;
 import com.miloshpetrov.sol2.*;
 import com.miloshpetrov.sol2.common.SolColor;
 import com.miloshpetrov.sol2.common.SolMath;
 import com.miloshpetrov.sol2.files.FileManager;
+import com.miloshpetrov.sol2.game.DebugOptions;
 import com.miloshpetrov.sol2.game.SolGame;
 import com.miloshpetrov.sol2.GameOptions;
 
@@ -53,7 +55,10 @@ public SolInputManager(TextureManager textureManager, float r) {
     myFlashPtr = new Ptr();
     myMousePos = new Vector2();
     myMousePrevPos = new Vector2();
-    Gdx.input.setCursorCatched(true);
+
+    // We want the original mouse cursor to be hidden as we draw our own mouse cursor.
+    Gdx.input.setCursorCatched(false);
+    setMouseCursorHidden();
     myUiCursor = textureManager.getTex("ui/cursor", null);
     myScreens = new ArrayList<SolUiScreen>();
     myToRemove = new ArrayList<SolUiScreen>();
@@ -64,6 +69,19 @@ public SolInputManager(TextureManager textureManager, float r) {
     myHoverSound = Gdx.audio.newSound(hoverSoundFile);
   }
 
+  /**
+   * Hides the mouse cursor by setting it to a transparent image.
+   */
+  private void setMouseCursorHidden() {
+    // When debugging the path has a "main" directory prepended
+    String debugPath = (DebugOptions.DEV_ROOT_PATH == null) ? "" : DebugOptions.DEV_ROOT_PATH;
+
+    // Load the cursor image - the hotspot is where the click point is which is in the middle in this image.
+    Pixmap pm = new Pixmap(Gdx.files.internal(debugPath + "res/imgs/cursorHidden.png"));
+    Gdx.input.setCursorImage(pm, 0, 0);
+    pm.dispose();
+  }
+
   public void maybeFlashPressed(int keyCode) {
     for (int i = 0, myScreensSize = myScreens.size(); i < myScreensSize; i++) {
       SolUiScreen screen = myScreens.get(i);
@@ -129,7 +147,17 @@ private static void setPtrPos(Ptr ptr, int screenX, int screenY) {
 
   public void update(SolApplication cmp) {
     boolean mobile = cmp.isMobile();
-    if (!mobile) maybeFixMousePos();
+    SolGame game = cmp.getGame();
+
+    // This keeps the mouse within the window, but only when playing the game with the mouse.
+    // All other times the mouse can freely leave and return.
+    if (!mobile && (cmp.getOptions().controlType == GameOptions.CONTROL_MIXED || cmp.getOptions().controlType == GameOptions.CONTROL_MOUSE) &&
+            game != null && getTopScreen() != game.getScreens().menuScreen) {
+      if(!Gdx.input.isCursorCatched()) Gdx.input.setCursorCatched(true);
+      maybeFixMousePos();
+    } else {
+      if(Gdx.input.isCursorCatched()) Gdx.input.setCursorCatched(false);
+    }
 
     updatePtrs();
 
@@ -172,7 +200,6 @@ public void update(SolApplication cmp) {
       screen.updateCustom(cmp, myPtrs, clickedOutside);
     }
 
-    SolGame game = cmp.getGame();
     TutorialManager tutorialManager = game == null ? null : game.getTutMan();
     if (tutorialManager != null && tutorialManager.isFinished()) {
       cmp.finishGame();