godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

State how 'MOUSE_MODE_CAPTURED' actually works in the 'Input' docs

This commit is contained in:
Michael Alexsander 2020-08-21 23:06:56 -03:00
parent d6510776dc
commit 4f13a7f47f
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/classes/Input.xml
View File

@ -417,7 +417,8 @@
Makes the mouse cursor hidden if it is visible. Makes the mouse cursor hidden if it is visible.
</constant> </constant>
<constant name="MOUSE_MODE_CAPTURED" value="2" enum="MouseMode"> <constant name="MOUSE_MODE_CAPTURED" value="2" enum="MouseMode">
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. On Windows and Linux, the mouse will use raw input mode, which means the reported movement will be unaffected by the OS' mouse acceleration settings. Captures the mouse. The mouse will be hidden and its position locked at the center of the screen.
[b]Note:[/b] If you want to process the mouse's movement in this mode, you need to use [member InputEventMouseMotion.relative].
</constant> </constant>
<constant name="MOUSE_MODE_CONFINED" value="3" enum="MouseMode"> <constant name="MOUSE_MODE_CONFINED" value="3" enum="MouseMode">
Makes the mouse cursor visible but confines it to the game window. Makes the mouse cursor visible but confines it to the game window.