From 3dc1fad2623b01bd8c8e5a83dfe198a8a2b0394e Mon Sep 17 00:00:00 2001
From: TechnicalSoup <ben.werbowyj@gmail.com>
Date: Thu, 3 Feb 2022 10:11:25 +1100
Subject: [PATCH] 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.
---
 doc/classes/Input.xml | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml
index 423e58f5c65..60f8925ab3d 100644
--- a/doc/classes/Input.xml
+++ b/doc/classes/Input.xml
@@ -383,7 +383,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 [code]MOUSE_MODE_CONFINED[/code] or [code]MOUSE_MODE_CONFINED_HIDDEN[/code].
 			</description>
 		</method>
 	</methods>