Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
Input¶
Inherits: Object
A singleton for handling inputs.
Description¶
The Input singleton handles key presses, mouse buttons and movement, gamepads, and input actions. Actions and their events can be set in the Input Map tab in Project > Project Settings, or with the InputMap class.
Note: Input's methods reflect the global input state and are not affected by Control.accept_event or Viewport.set_input_as_handled, as those methods only deal with the way input is propagated in the SceneTree.
Tutorials¶
Properties¶
Methods¶
Signals¶
joy_connection_changed ( int device, bool connected )
Emitted when a joypad device has been connected or disconnected.
Enumerations¶
enum MouseMode:
MouseMode MOUSE_MODE_VISIBLE = 0
Makes the mouse cursor visible if it is hidden.
Makes the mouse cursor hidden if it is visible.
MouseMode MOUSE_MODE_CAPTURED = 2
Captures the mouse. The mouse will be hidden and its position locked at the center of the window manager's window.
Note: If you want to process the mouse's movement in this mode, you need to use InputEventMouseMotion.relative.
MouseMode MOUSE_MODE_CONFINED = 3
Confines the mouse cursor to the game window, and make it visible.
Confines the mouse cursor to the game window, and make it hidden.
enum CursorShape:
CursorShape CURSOR_ARROW = 0
Arrow cursor. Standard, default pointing cursor.
CursorShape CURSOR_IBEAM = 1
I-beam cursor. Usually used to show where the text cursor will appear when the mouse is clicked.
CursorShape CURSOR_POINTING_HAND = 2
Pointing hand cursor. Usually used to indicate the pointer is over a link or other interactable item.
CursorShape CURSOR_CROSS = 3
Cross cursor. Typically appears over regions in which a drawing operation can be performed or for selections.
CursorShape CURSOR_WAIT = 4
Wait cursor. Indicates that the application is busy performing an operation. This cursor shape denotes that the application isn't usable during the operation (e.g. something is blocking its main thread).
CursorShape CURSOR_BUSY = 5
Busy cursor. Indicates that the application is busy performing an operation. This cursor shape denotes that the application is still usable during the operation.
CursorShape CURSOR_DRAG = 6
Drag cursor. Usually displayed when dragging something.
Note: Windows lacks a dragging cursor, so CURSOR_DRAG is the same as CURSOR_MOVE for this platform.
CursorShape CURSOR_CAN_DROP = 7
Can drop cursor. Usually displayed when dragging something to indicate that it can be dropped at the current position.
CursorShape CURSOR_FORBIDDEN = 8
Forbidden cursor. Indicates that the current action is forbidden (for example, when dragging something) or that the control at a position is disabled.
CursorShape CURSOR_VSIZE = 9
Vertical resize mouse cursor. A double-headed vertical arrow. It tells the user they can resize the window or the panel vertically.
CursorShape CURSOR_HSIZE = 10
Horizontal resize mouse cursor. A double-headed horizontal arrow. It tells the user they can resize the window or the panel horizontally.
CursorShape CURSOR_BDIAGSIZE = 11
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.
CursorShape CURSOR_FDIAGSIZE = 12
Window resize mouse cursor. The cursor is a double-headed arrow that goes from the top left to the bottom right, the opposite of