Expand description for warp_mouse_position method

Add more detail to the description for the warp_mouse_position method, clarifying that the vector is in screen coordinates and relative to an origin at the top of the game window.

(cherry picked from commit 3dc1fad262)
This commit is contained in:
TechnicalSoup 2022-02-03 10:11:25 +11:00 committed by Rémi Verschelde
parent 6bcb24f1b8
commit 49059e3f26
No known key found for this signature in database
GPG key ID: C3336907360768E1

View file

@ -408,7 +408,8 @@
<return type="void" />
<argument index="0" name="to" type="Vector2" />
<description>
Sets the mouse position to the specified vector.
Sets the mouse position to the specified vector, provided in pixels and relative to an origin at the upper left corner of the game window.
Mouse position is clipped to the limits of the screen resolution, or to the limits of the game window if [enum MouseMode] is set to [constant MOUSE_MODE_CONFINED].
</description>
</method>
</methods>