From 46de6afc4053f196ba24a0d01ceece836af8128a Mon Sep 17 00:00:00 2001 From: Max Hilbrunner Date: Tue, 13 Mar 2018 17:18:36 +0100 Subject: [PATCH] [DOCS] Input (cherry picked from commit 22cb4a1cf95910a4e41f72010778e7f3651216b1) --- doc/classes/Input.xml | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index ca21fe1e9ef..49c1dd60312 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -7,6 +7,7 @@ A Singleton that deals with inputs. This includes key presses, mouse buttons and movement, joypads, and input actions. Actions and their events can be set in the Project Settings / Input Map tab. Or be set with [InputMap]. + http://docs.godotengine.org/en/3.0/tutorials/inputs/index.html @@ -44,7 +45,7 @@ - If the device has an accelerometer, this will return the movement. + If the device has an accelerometer, this will return the acceleration. Otherwise, it returns an empty [Vector3]. @@ -58,13 +59,14 @@ + If the device has an accelerometer, this will return the gravity. Otherwise, it returns an empty [Vector3]. - If the device has a gyroscope, this will return the rate of rotation in rad/s around a device's x, y, and z axis. + If the device has a gyroscope, this will return the rate of rotation in rad/s around a device's x, y, and z axis. Otherwise, it returns an empty [Vector3]. @@ -259,6 +261,7 @@ + Feeds an [InputEvent] to the game. Can be used to artificially trigger input events from code. @@ -334,7 +337,7 @@ - Emitted when a joypad device has been connected or disconnected + Emitted when a joypad device has been connected or disconnected. @@ -349,40 +352,58 @@ Captures the mouse. The mouse will be hidden and unable to leave the game window. But it will still register movement and mouse button presses. + Makes the mouse cursor visible but confines it to the game window. + Arrow cursor. Standard, default pointing cursor. + I-beam cursor. Usually used to show where the text cursor will appear when the mouse is clicked. + Pointing hand cursor. Usually used to indicate the pointer is over a link or other interactable item. + Cross cursor. Typically appears over regions in which a drawing operation can be performance or for selections. + Wait cursor. Indicates that the application is busy performing an operation. + Busy cursor. See [code]CURSOR_WAIT[/code]. + Drag cursor. Usually displayed when dragging something. + Can drop cursor. Usually displayed when dragging something to indicate that it can be dropped at the current position. + Forbidden cursor. Indicates that the current action is forbidden (for example, when dragging something) or that the control at a position is disabled. + Vertical resize mouse cursor. A double headed vertical arrow. It tells the user they can resize the window or the panel vertically. + Horizontal resize mouse cursor. A double headed horizontal arrow. It tells the user they can resize the window or the panel horizontally. + Window resize mouse cursor. The cursor is a double headed arrow that goes from the bottom left to the top right. It tells the user they can resize the window or the panel both horizontally and vertically. + Window resize mouse cursor. The cursor is a double headed arrow that goes from the top left to the bottom right, the opposite of [code]CURSOR_BDIAGSIZE[/code]. It tells the user they can resize the window or the panel both horizontally and vertically. + Move cursor. Indicates that something can be moved. + Vertical split mouse cursor. On Windows, it's the same as [code]CURSOR_VSIZE[/code]. + Horizontal split mouse cursor. On Windows, it's the same as [code]CURSOR_HSIZE[/code]. + Help cursor. Usually a question mark.