Răsfoiți Sursa

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 3dc1fad2623b01bd8c8e5a83dfe198a8a2b0394e)
TechnicalSoup 3 ani în urmă
părinte
comite
49059e3f26
1 a modificat fișierele cu 2 adăugiri și 1 ștergeri
  1. 2 1
      doc/classes/Input.xml

+ 2 - 1
doc/classes/Input.xml

@@ -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>