diff options
| author | TechnicalSoup <ben.werbowyj@gmail.com> | 2022-02-03 10:11:25 +1100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-02-03 10:11:25 +1100 |
| commit | 3dc1fad2623b01bd8c8e5a83dfe198a8a2b0394e (patch) | |
| tree | 86c1d03907d92d06a9b7673ef6d6183ada0ec967 | |
| parent | 6de5bafd2fa7513cf78377b61c2606327b293d44 (diff) | |
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.
| -rw-r--r-- | doc/classes/Input.xml | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 423e58f5c6..60f8925ab3 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> |