Up to date
This page is up to date for Godot 4.0.
If you still find outdated information, please open an issue.
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 CURSOR_BDIAGSIZE. It tells the user they can resize the window or the panel both horizontally and vertically.
CursorShape CURSOR_MOVE = 13
Move cursor. Indicates that something can be moved.
CursorShape CURSOR_VSPLIT = 14
Vertical split mouse cursor. On Windows, it's the same as CURSOR_VSIZE.
CursorShape CURSOR_HSPLIT = 15
Horizontal split mouse cursor. On Windows, it's the same as CURSOR_HSIZE.
CursorShape CURSOR_HELP = 16
Help cursor. Usually a question mark.
Property Descriptions¶
MouseMode mouse_mode
Controls the mouse mode. See MouseMode for more information.
bool use_accumulated_input
If true, similar input events sent by the operating system are accumulated. When input accumulation is enabled, all input events generated during a frame will be merged and emitted when the frame is done rendering. Therefore, this limits the number of input method calls per second to the rendering FPS.
Input accumulation can be disabled to get slightly more precise/reactive input at the cost of increased CPU usage. In applications where drawing freehand lines is required, input accumulation should generally be disabled while the user is drawing the line to get results that closely follow the actual input.
Note: Input accumulation is enabled by default.
Method Descriptions¶
void action_press ( StringName action, float strength=1.0 )
This will simulate pressing the specified action.
The strength can be used for non-boolean actions, it's ranged between 0 and 1 representing the intensity of the given action.
Note: This method will not cause any Node._input calls. It is intended to be used with is_action_pressed and is_action_just_pressed. If you want to simulate _input, use parse_input_event instead.
void action_release ( StringName action )
If the specified action is already pressed, this will release it.
void add_joy_mapping ( String mapping, bool update_existing=false )
Adds a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices.
void flush_buffered_events ( )
Sends all input events which are in the current buffer to the game loop. These events may have been buffered as a result of accumulated input (use_accumulated_input) or agile input flushing (ProjectSettings.input_devices/buffering/agile_event_flushing).
The engine will already do this itself at key execution points (at least once per frame). However, this can be useful in advanced cases where you want precise control over the timing of event handling.
Vector3 get_accelerometer ( ) const
Returns the acceleration in m/s² of the device's accelerometer sensor, if the device has one. Otherwise, the method returns Vector3.ZERO.
Note this method returns an empty Vector3 when running from the editor even when your device has an accelerometer. You must export your project to a supported device to read values from the accelerometer.
Note: This method only works on iOS, Android, and UWP. On other platforms, it always returns Vector3.ZERO.
float get_action_raw_strength ( StringName action, bool exact_match=false ) const
Returns a value between 0 and 1 representing the raw intensity of the given action, ignoring the action's deadzone. In most cases, you should use get_action_strength instead.
If exact_match is false, it ignores additional input modifiers for InputEventKey and InputEventMouseButton events, and the direction for InputEventJoypadMotion events.
float get_action_strength ( StringName action, bool exact_match=false ) const
Returns a value between 0 and 1 representing the intensity of the given action. In a joypad, for example, the further away the axis (analog sticks or L2, R2 triggers) is from the dead zone, the closer the value will be to 1. If the action is mapped to a control that has no axis as the keyboard, the value returned will be 0 or 1.
If exact_match is false, it ignores additional input modifiers for InputEventKey and InputEventMouseButton events, and the direction for InputEventJoypadMotion events.
float get_axis ( StringName negative_action, StringName positive_action ) const
Get axis input by specifying two actions, one negative and one positive.
This is a shorthand for writing Input.get_action_strength("positive_action") - Input.get_action_strength("negative_action").
int[] get_connected_joypads ( )
Returns an Array containing the device IDs of all currently connected joypads.
CursorShape get_current_cursor_shape ( ) const
Returns the currently assigned cursor shape (see CursorShape).
Vector3 get_gravity ( ) const
Returns the gravity in m/s² of the device's accelerometer sensor, if the device has one. Otherwise, the method returns Vector3.ZERO.
Note: This method only works on Android and iOS. On other platforms, it always returns Vector3.ZERO.
Vector3 get_gyroscope ( ) const
Returns the rotation rate in rad/s around a device's X, Y, and Z axes of the gyroscope sensor, if the device has one. Otherwise, the method returns Vector3.ZERO.
Note: This method only works on Android and iOS. On other platforms, it always returns Vector3.ZERO.
float get_joy_axis ( int device, JoyAxis axis ) const
Returns the current value of the joypad axis at given index (see JoyAxis).
String get_joy_guid ( int device ) const
Returns a SDL2-compatible device GUID on platforms that use gamepad remapping, e.g. 030000004c050000c405000000010000. Returns "Default Gamepad" otherwise. Godot uses the SDL2 game controller database to determine gamepad names and mappings based on this GUID.
String get_joy_name ( int device )
Returns the name of the joypad at the specified device index, e.g. PS4 Controller. Godot uses the SDL2 game controller database to determine gamepad names.
float get_joy_vibration_duration ( int device )
Returns the duration of the current vibration effect in seconds.
Vector2 get_joy_vibration_strength ( int device )
Returns the strength of the joypad vibration: x is the strength of the weak motor, and y is the strength of the strong motor.
Vector2 get_last_mouse_velocity ( )
Returns the last mouse velocity. To provide a precise and jitter-free velocity, mouse velocity is only calculated every 0.1s. Therefore, mouse velocity will lag mouse movements.
Vector3 get_magnetometer ( ) const
Returns the magnetic field strength in micro-Tesla for all axes of the device's magnetometer sensor, if the device has one. Otherwise, the method returns Vector3.ZERO.
Note: This method only works on Android, iOS and UWP. On other platforms, it always returns Vector3.ZERO.
MouseButtonMask get_mouse_button_mask ( ) const
Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the same time, the bits are added together. Equivalent to DisplayServer.mouse_get_button_state.
Vector2 get_vector ( StringName negative_x, StringName positive_x, StringName negative_y, StringName positive_y, float deadzone=-1.0 ) const
Gets an input vector by specifying four actions for the positive and negative X and Y axes.
This method is useful when getting vector input, such as from a joystick, directional pad, arrows, or WASD. The vector has its length limited to 1 and has a circular deadzone, which is useful for using vector input as movement.
By default, the deadzone is automatically calculated from the average of the action deadzones. However, you can override the deadzone to be whatever you want (on the range of 0 to 1).
bool is_action_just_pressed ( StringName action, bool exact_match=false ) const
Returns true when the user starts pressing the action event, meaning it's true only on the frame that the user pressed down the button.
This is useful for code that needs to run only once whe