Document when mouse moves are unlikely to work.

Fixes #6126.
2025-02-05 23:40:10 -05:00
parent 24a8135657
commit 6793d7e5fa
2 changed files with 8 additions and 1 deletions
@@ -478,6 +478,9 @@ init -1500 python:
        or if the :var:`"automatic move" preference <preferences.mouse_move>`
        is False, this does nothing.

+        This is unlikely to work on the Linux with Wayland, Android, iOS, or Web
+        platforms.
+
        `duration`
            The time it will take to perform the move, in seconds. During
            this time, the mouse may be unresponsive.
@@ -1145,7 +1145,11 @@ def set_mouse_pos(x, y, duration=0):
    :doc: other

    Jump the mouse pointer to the location given by arguments x and y.
-    If the device does not have a mouse pointer, this does nothing.
+    If the device does not have a mouse pointer, or if it is not possible for
+    Ren'Py to move that pointer, this does nothing.
+
+    This is unlikely to work on the Linux with Wayland, Android, iOS, or Web
+    platforms.

    `duration`
        The time it will take to perform the move, in seconds.