A singleton for handling inputs.
The [Input] singleton handles key presses, mouse buttons and movement, gamepads, and input actions. Actions and their events can be set in the [b]Input Map[/b] tab in [b]Project > Project Settings[/b], or with the [InputMap] class. [b]Note:[/b] [Input]'s methods reflect the global input state and are not affected by [method Control.accept_event] or [method Viewport.set_input_as_handled], as those methods only deal with the way input is propagated in the [SceneTree].
$DOCS_URL/tutorials/inputs/index.html https://godotengine.org/asset-library/asset/2712 https://godotengine.org/asset-library/asset/2755
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. [b]Note:[/b] This method will not cause any [method Node._input] calls. It is intended to be used with [method is_action_pressed] and [method is_action_just_pressed]. If you want to simulate [code]_input[/code], use [method parse_input_event] instead.
If the specified action is already pressed, this will release it.
Adds a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices.
Clears the calibration information for the specified joypad's motion sensors, if it has any and if they were calibrated. See [method start_joy_motion_sensors_calibration] for an example on how to use joypad motion sensors and calibration in your games. [b]Note:[/b] This feature is only supported on Windows, Linux, macOS, and iOS.
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 ([member use_accumulated_input]) or agile input flushing ([member 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.
Returns the acceleration in m/s² of the device's accelerometer sensor, if the device has one. Otherwise, the method returns [constant 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. [b]Note:[/b] This method only works on Android and iOS. On other platforms, it always returns [constant Vector3.ZERO]. [b]Note:[/b] For Android, [member ProjectSettings.input_devices/sensors/enable_accelerometer] must be enabled.
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 [method get_action_strength] instead. If [param exact_match] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
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 such as the keyboard, the value returned will be 0 or 1. If [param exact_match] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
Get axis input by specifying two actions, one negative and one positive. This is a shorthand for writing [code]Input.get_action_strength("positive_action") - Input.get_action_strength("negative_action")[/code].
Returns an [Array] containing the device IDs of all currently connected joypads.
Returns the currently assigned cursor shape.
Returns the gravity in m/s² of the device's accelerometer sensor, if the device has one. Otherwise, the method returns [constant Vector3.ZERO]. [b]Note:[/b] This method only works on Android and iOS. On other platforms, it always returns [constant Vector3.ZERO]. [b]Note:[/b] For Android, [member ProjectSettings.input_devices/sensors/enable_gravity] must be enabled.
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 [constant Vector3.ZERO]. [b]Note:[/b] This method only works on Android and iOS. On other platforms, it always returns [constant Vector3.ZERO]. [b]Note:[/b] For Android, [member ProjectSettings.input_devices/sensors/enable_gyroscope] must be enabled.
Returns the acceleration, including the force of gravity, in m/s² of the joypad's accelerometer sensor, if the joypad has one and it's currently enabled. Otherwise, the method returns [constant Vector3.ZERO]. See also [method get_joy_gravity] and [method set_joy_motion_sensors_enabled]. For a joypad held in front of you, the returned axes are defined as follows: +X ... -X: left ... right; +Y ... -Y: bottom ... top; +Z ... -Z: farther ... closer. The gravity part value is measured as a vector with length of [code]9.8[/code] away from the center of the Earth, which is a negative Y value. [b]Note:[/b] This feature is only supported on Windows, Linux, and macOS. On iOS, joypad accelerometer sensor reading is not supported due to OS limitations.
Returns the current value of the joypad axis at index [param axis].
Returns the gravity in m/s² of the joypad's accelerometer sensor, if the joypad has one and it's currently enabled. Otherwise, the method returns [constant Vector3.ZERO]. See also [method get_joy_accelerometer] and [method set_joy_motion_sensors_enabled]. For a joypad held in front of you, the returned axes are defined as follows: +X ... -X: left ... right; +Y ... -Y: bottom ... top; +Z ... -Z: farther ... closer. The gravity part value is measured as a vector with length of [code]9.8[/code] away from the center of the Earth, which is a negative Y value. [b]Note:[/b] This feature is only supported on Windows, Linux, and macOS. On iOS, joypad accelerometer sensor reading is not supported due to OS limitations.
Returns an SDL-compatible device GUID on platforms that use gamepad remapping, e.g. [code]030000004c050000c405000000010000[/code]. Returns an empty string if it cannot be found. Godot uses SDL's internal mappings, supplemented by community-contributed mappings, to determine gamepad names and mappings based on this GUID. On Windows, all XInput joypad GUIDs will be overridden by Godot to [code]__XINPUT_DEVICE__[/code], because their mappings are the same.
Returns the rotation rate in rad/s around a joypad's X, Y, and Z axes of the gyroscope sensor, if the joypad has one and it's currently enabled. Otherwise, the method returns [constant Vector3.ZERO]. See also [method set_joy_motion_sensors_enabled]. The rotation is positive in the counter-clockwise direction. For a joypad held in front of you, the returned axes are defined as follows: X: Angular speed around the X axis (pitch); Y: Angular speed around the Y axis (yaw); Z: Angular speed around the Z axis (roll). See [method start_joy_motion_sensors_calibration] for an example on how to use joypad gyroscope and gyroscope calibration in your games. [b]Note:[/b] This feature is only supported on Windows, Linux, macOS, and iOS.
Returns a dictionary with extra platform-specific information about the device, e.g. the raw gamepad name from the OS or the Steam Input index. On Windows, Linux, macOS, and iOS, the dictionary contains the following fields: [code]raw_name[/code]: The name of the controller as it came from the OS, before getting renamed by the controller database. [code]vendor_id[/code]: The USB vendor ID of the device. [code]product_id[/code]: The USB product ID of the device. [code]serial_number[/code]: The serial number of the device. This key won't be present if the serial number is unavailable. The dictionary can also include the following fields under selected platforms: [code]steam_input_index[/code]: The Steam Input gamepad index (Windows, Linux, and macOS only). If the device is not a Steam Input device this key won't be present. [code]xinput_index[/code]: The index of the controller in the XInput system (Windows only). This key won't be present for devices not handled by XInput. [b]Note:[/b] The returned dictionary is always empty on Android and Web.
Returns the calibration information about the specified joypad's motion sensors in the form of a [Dictionary], if it has any and if they have been calibrated, otherwise returns an empty [Dictionary]. The dictionary contains the following fields: [code]gyroscope_offset[/code]: average offset in gyroscope values from [constant Vector2.ZERO] in rad/s. See [method start_joy_motion_sensors_calibration] for an example on how to use joypad motion sensors and calibration in your games. [b]Note:[/b] This feature is only supported on Windows, Linux, macOS, and iOS.
Returns the joypad's motion sensor rate in Hz, if the joypad has motion sensors and they're currently enabled. See also [method set_joy_motion_sensors_enabled]. [b]Note:[/b] This feature is only supported on Windows, Linux, macOS, and iOS.
Returns the name of the joypad at the specified device index, e.g. [code]PS4 Controller[/code]. Godot uses the [url=https://github.com/gabomdq/SDL_GameControllerDB]SDL2 game controller database[/url] to determine gamepad names.
Returns the duration of the current vibration effect in seconds. [b]Note:[/b] This method returns the same value that was passed to [method start_joy_vibration], and this value does [b]not[/b] change when the joypad's vibration runs out, it only gets reset after a call to [method stop_joy_vibration]. If you want to check if a joypad is still vibrating, use [method is_joy_vibrating] instead.
Returns the remaining duration of the current vibration effect in seconds.
Returns the strength of the joypad vibration: x is the strength of the weak motor, and y is the strength of the strong motor. [b]Note:[/b] This method returns the same values that were passed to [method start_joy_vibration], and these values do [b]not[/b] change when the joypad's vibration runs out, they only get reset after a call to [method stop_joy_vibration]. If you want to check if a joypad is still vibrating, use [method is_joy_vibrating] instead.
Returns the last mouse velocity in screen coordinates. To provide a precise and jitter-free velocity, mouse velocity is only calculated every 0.1s. Therefore, mouse velocity will lag mouse movements.
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.
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 [constant Vector3.ZERO]. [b]Note:[/b] This method only works on Android and iOS. On other platforms, it always returns [constant Vector3.ZERO]. [b]Note:[/b] For Android, [member ProjectSettings.input_devices/sensors/enable_magnetometer] must be enabled.
Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the same time, the bits are added together. Equivalent to [method DisplayServer.mouse_get_button_state].
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).
Returns [code]true[/code] if the joypad has an LED light that can change colors and/or brightness. See also [method set_joy_light]. [b]Note:[/b] This feature is only supported on Windows, Linux, macOS, and iOS.
Returns [code]true[/code] if the joypad has motion sensors (accelerometer and gyroscope). [b]Note:[/b] On iOS, joypad accelerometer sensor reading is not supported due to OS limitations. [b]Note:[/b] This feature is only supported on Windows, Linux, macOS, and iOS.
Returns [code]true[/code] if the joypad supports vibration. See also [method start_joy_vibration]. [b]Note:[/b] For macOS, vibration is only supported in macOS 11 and later. When connected via USB, vibration is only supported for major brand controllers (except Xbox One and Xbox Series X/S controllers) due to macOS limitations.
Returns [code]true[/code] when the user has [i]started[/i] pressing the action event in the current frame or physics tick. It will only return [code]true[/code] on the frame or tick that the user pressed down the button. This is useful for code that needs to run only once when an action is pressed, instead of every frame while it's pressed. If [param exact_match] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. [b]Note:[/b] Returning [code]true[/code] does not imply that the action is [i]still[/i] pressed. An action can be pressed and released again rapidly, and [code]true[/code] will still be returned so as not to miss input. [b]Note:[/b] Due to keyboard ghosting, [method is_action_just_pressed] may return [code]false[/code] even if one of the action's keys is pressed. See [url=$DOCS_URL/tutorials/inputs/input_examples.html#keyboard-events]Input examples[/url] in the documentation for more information. [b]Note:[/b] During input handling (e.g. [method Node._input]), use [method InputEvent.is_action_pressed] instead to query the action state of the current event. See also [method is_action_just_pressed_by_event].
Returns [code]true[/code] when the user has [i]started[/i] pressing the action event in the current frame or physics tick, and the first event that triggered action press in the current frame/physics tick was [param event]. It will only return [code]true[/code] on the frame or tick that the user pressed down the button. This is useful for code that needs to run only once when an action is pressed, and the action is processed during input handling (e.g. [method Node._input]). If [param exact_match] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. [b]Note:[/b] Returning [code]true[/code] does not imply that the action is [i]still[/i] pressed. An action can be pressed and released again rapidly, and [code]true[/code] will still be returned so as not to miss input. [b]Note:[/b] Due to keyboard ghosting, [method is_action_just_pressed] may return [code]false[/code] even if one of the action's keys is pressed. See [url=$DOCS_URL/tutorials/inputs/input_examples.html#keyboard-events]Input examples[/url] in the documentation for more information.
Returns [code]true[/code] when the user [i]stops[/i] pressing the action event in the current frame or physics tick. It will only return [code]true[/code] on the frame or tick that the user releases the button. [b]Note:[/b] Returning [code]true[/code] does not imply that the action is [i]still[/i] not pressed. An action can be released and pressed again rapidly, and [code]true[/code] will still be returned so as not to miss input. If [param exact_match] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. [b]Note:[/b] During input handling (e.g. [method Node._input]), use [method InputEvent.is_action_released] instead to query the action state of the current event. See also [method is_action_just_released_by_event].
Returns [code]true[/code] when the user [i]stops[/i] pressing the action event in the current frame or physics tick, and the first event that triggered action release in the current frame/physics tick was [param event]. It will only return [code]true[/code] on the frame or tick that the user releases the button. This is useful when an action is processed during input handling (e.g. [method Node._input]). [b]Note:[/b] Returning [code]true[/code] does not imply that the action is [i]still[/i] not pressed. An action can be released and pressed again rapidly, and [code]true[/code] will still be returned so as not to miss input. If [param exact_match] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
Returns [code]true[/code] if you are pressing the action event. If [param exact_match] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. [b]Note:[/b] Due to keyboard ghosting, [method is_action_pressed] may return [code]false[/code] even if one of the action's keys is pressed. See [url=$DOCS_URL/tutorials/inputs/input_examples.html#keyboard-events]Input examples[/url] in the documentation for more information.
Returns [code]true[/code] if any action, key, joypad button, or mouse button is being pressed. This will also return [code]true[/code] if any action is simulated via code by calling [method action_press].
Returns [code]true[/code] if you are pressing the joypad button at index [param button].
Returns [code]true[/code] if the system knows the specified device. This means that it sets all button and axis indices. Unknown joypads are not expected to match these constants, but you can still retrieve events from them.
Returns [code]true[/code] if the joypad's motion sensors have been calibrated. See [method start_joy_motion_sensors_calibration] for an example on how to use joypad motion sensors and calibration in your games. [b]Note:[/b] This feature is only supported on Windows, Linux, macOS, and iOS.
Returns [code]true[/code] if the joypad's motion sensors are currently being calibrated. See [method start_joy_motion_sensors_calibration] for an example on how to use joypad motion sensors and calibration in your games. [b]Note:[/b] This feature is only supported on Windows, Linux, macOS, and iOS.
Returns [code]true[/code] if the requested joypad has motion sensors (accelerometer and gyroscope) and they are currently enabled. See also [method set_joy_motion_sensors_enabled] and [method has_joy_motion_sensors]. See [method start_joy_motion_sensors_calibration] for an example on how to use joypad motion sensors and calibration in your games. [b]Note:[/b] This feature is only supported on Windows, Linux, macOS, and iOS.
Returns [code]true[/code] if the joypad is still vibrating after a call to [method start_joy_vibration]. Unlike [method get_joy_vibration_strength] and [method get_joy_vibration_duration], this method returns [code]false[/code] after the joypad's vibration runs out.
Returns [code]true[/code] if you are pressing the key with the [param keycode] printed on it. You can pass a [enum Key] constant or any Unicode character code.
Returns [code]true[/code] if you are pressing the Latin key in the current keyboard layout. You can pass a [enum Key] constant. [method is_key_pressed] is only recommended over [method is_physical_key_pressed] in non-game applications. This ensures that shortcut keys behave as expected depending on the user's keyboard layout, as keyboard shortcuts are generally dependent on the keyboard layout in non-game applications. If in doubt, use [method is_physical_key_pressed]. [b]Note:[/b] Due to keyboard ghosting, [method is_key_pressed] may return [code]false[/code] even if one of the action's keys is pressed. See [url=$DOCS_URL/tutorials/inputs/input_examples.html#keyboard-events]Input examples[/url] in the documentation for more information.
Returns [code]true[/code] if you are pressing the mouse button specified with [enum MouseButton].
Returns [code]true[/code] if you are pressing the key in the physical location on the 101/102-key US QWERTY keyboard. You can pass a [enum Key] constant. [method is_physical_key_pressed] is recommended over [method is_key_pressed] for in-game actions, as it will make [kbd]W[/kbd]/[kbd]A[/kbd]/[kbd]S[/kbd]/[kbd]D[/kbd] layouts work regardless of the user's keyboard layout. [method is_physical_key_pressed] will also ensure that the top row number keys work on any keyboard layout. If in doubt, use [method is_physical_key_pressed]. [b]Note:[/b] Due to keyboard ghosting, [method is_physical_key_pressed] may return [code]false[/code] even if one of the action's keys is pressed. See [url=$DOCS_URL/tutorials/inputs/input_examples.html#keyboard-events]Input examples[/url] in the documentation for more information.
Feeds an [InputEvent] to the game. Can be used to artificially trigger input events from code. Also generates [method Node._input] calls. [codeblocks] [gdscript] var cancel_event = InputEventAction.new() cancel_event.action = "ui_cancel" cancel_event.pressed = true Input.parse_input_event(cancel_event) [/gdscript] [csharp] var cancelEvent = new InputEventAction(); cancelEvent.Action = "ui_cancel"; cancelEvent.Pressed = true; Input.ParseInputEvent(cancelEvent); [/csharp] [/codeblocks] [b]Note:[/b] Calling this function has no influence on the operating system. So for example sending an [InputEventMouseMotion] will not move the OS mouse cursor to the specified position (use [method warp_mouse] instead) and sending [kbd]Alt/Cmd + Tab[/kbd] as [InputEventKey] won't toggle between active windows.
Removes all mappings from the internal database that match the given GUID. All currently connected joypads that use this GUID will become unmapped. On Android, Godot will map to an internal fallback mapping.
Sets the acceleration value of the accelerometer sensor. Can be used for debugging on devices without a hardware sensor, for example in an editor on a PC. [b]Note:[/b] This value can be immediately overwritten by the hardware sensor value on Android and iOS.
Sets a custom mouse cursor image, which is only visible inside the game window, for the given mouse [param shape]. The hotspot can also be specified. Passing [code]null[/code] to the image parameter resets to the system cursor. [param image] can be either [Texture2D] or [Image] and its size must be lower than or equal to 256×256. To avoid rendering issues, sizes lower than or equal to 128×128 are recommended. [param hotspot] must be within [param image]'s size. [b]Note:[/b] [AnimatedTexture]s aren't supported as custom mouse cursors. If using an [AnimatedTexture], only the first frame will be displayed. [b]Note:[/b] The [b]Lossless[/b], [b]Lossy[/b] or [b]Uncompressed[/b] compression modes are recommended. The [b]Video RAM[/b] compression mode can be used, but it will be decompressed on the CPU, which means loading times are slowed down and no memory is saved compared to lossless modes. [b]Note:[/b] On the web platform, the maximum allowed cursor image size is 128×128. Cursor images larger than 32×32 will also only be displayed if the mouse cursor image is entirely located within the page for [url=https://chromestatus.com/feature/5825971391299584]security reasons[/url].
Sets the default cursor shape to be used in the viewport instead of [constant CURSOR_ARROW]. [b]Note:[/b] If you want to change the default cursor shape for [Control]'s nodes, use [member Control.mouse_default_cursor_shape] instead. [b]Note:[/b] This method generates an [InputEventMouseMotion] to update cursor immediately.
Sets the gravity value of the accelerometer sensor. Can be used for debugging on devices without a hardware sensor, for example in an editor on a PC. [b]Note:[/b] This value can be immediately overwritten by the hardware sensor value on Android and iOS.
Sets the value of the rotation rate of the gyroscope sensor. Can be used for debugging on devices without a hardware sensor, for example in an editor on a PC. [b]Note:[/b] This value can be immediately overwritten by the hardware sensor value on Android and iOS.
Sets the joypad's LED light, if available, to the specified color. See also [method has_joy_light]. [b]Note:[/b] There is no way to get the color of the light from a joypad. If you need to know the assigned color, store it separately. [b]Note:[/b] This feature is only supported on Windows, Linux, macOS, and iOS.
Sets the specified joypad's calibration information. See also [method get_joy_motion_sensors_calibration]. See [method start_joy_motion_sensors_calibration] for an example on how to use joypad motion sensors and calibration in your games. [b]Note:[/b] This feature is only supported on Windows, Linux, macOS, and iOS.
Enables or disables the motion sensors (accelerometer and gyroscope), if available, on the specified joypad. See [method start_joy_motion_sensors_calibration] for an example on how to use joypad motion sensors and calibration in your games. It's recommended to disable the motion sensors when they're no longer being used, because otherwise it might drain the controller battery faster. [b]Note:[/b] This feature is only supported on Windows, Linux, macOS, and iOS.
Sets the value of the magnetic field of the magnetometer sensor. Can be used for debugging on devices without a hardware sensor, for example in an editor on a PC. [b]Note:[/b] This value can be immediately overwritten by the hardware sensor value on Android and iOS.
Queries whether an input device should be ignored or not. Devices can be ignored by setting the environment variable [code]SDL_GAMECONTROLLER_IGNORE_DEVICES[/code]. Read the [url=https://wiki.libsdl.org/SDL2]SDL documentation[/url] for more information. [b]Note:[/b] Some 3rd party tools can contribute to the list of ignored devices. For example, [i]SteamInput[/i] creates virtual devices from physical devices for remapping purposes. To avoid handling the same input device twice, the original device is added to the ignore list.
Starts the process of calibrating the specified joypad's gyroscope, if it has one. Once a joypad's gyroscope has been calibrated correctly (e.g. laying still on a table without being rotated), [method get_joy_gyroscope] will return values close or equal to [constant Vector3.ZERO] when the joypad is not being rotated. Here's an example of how to use joypad gyroscope and gyroscope calibration in your games: [codeblocks] [gdscript] const GYRO_SENSITIVITY = 10.0

func _ready(): # In this example we only use the first connected joypad (id 0). if 0 not in Input.get_connected_joypads(): return

if not Input.has_joy_motion_sensors(0): return

# We must enable the motion sensors before using them. Input.set_joy_motion_sensors_enabled(0, true)

# (Tell the users here that they need to put their joypads on a flat surface and wait for confirmation.)

# Start the calibration process. calibrate_motion()

func _process(delta): # Only move the object if the joypad motion sensors are calibrated. if Input.is_joy_motion_sensors_calibrated(0): move_object(delta)

func calibrate_motion(): Input.start_joy_motion_sensors_calibration(0)

# Wait for some time. await get_tree().create_timer(1.0).timeout

Input.stop_joy_motion_sensors_calibration(0) # The joypad is now calibrated.

func move_object(delta): var node: Node3D = ... # Put your node here.

var gyro := Input.get_joy_gyroscope(0) node.rotation.x -= -gyro.y * GYRO_SENSITIVITY * delta # Use rotation around the Y axis (yaw) here. node.rotation.y += -gyro.x * GYRO_SENSITIVITY * delta # Use rotation around the X axis (pitch) here. [/gdscript] [csharp] private const float GyroSensitivity = 10.0;

public override void _Ready() { // In this example we only use the first connected joypad (id 0). if (!Input.GetConnectedJoypads().Contains(0)) { return; }

if (!Input.HasJoyMotionSensors(0)) { return; }

// We must enable the accelerometer and the gyroscope before using them. Input.SetJoyMotionSensorsEnabled(0, true);

// (Tell the users here that they need to put their joypads on a flat surface and wait for confirmation.)

// Start the calibration process. CalibrateMotion(); }

public override void _Process(double delta) { // Only move the object if the joypad motion sensors are calibrated. if (Input.IsJoyMotionSensorsCalibrated(0)) { MoveObject(delta); } }

private async Task CalibrateMotion() { Input.StartJoyMotionSensorsCalibration(0);

// Wait for some time. await ToSignal(GetTree().CreateTimer(1.0), SceneTreeTimer.SignalName.Timeout);

Input.StopJoyMotionSensorsCalibration(0); // The joypad is now calibrated. }

private void MoveObject(double delta) { Node3D node = ... ; // Put your object here. Vector3 gyro = Input.GetJoyGyroscope(0); Vector3 rotation = node.Rotation; rotation.X -= -gyro.Y * GyroSensitivity * (float)delta; // Use rotation around the Y axis (yaw) here. rotation.Y += -gyro.X * GyroSensitivity * (float)delta; // Use rotation around the X axis (pitch) here. node.Rotation = rotation; } [/csharp] [/codeblocks] [b]Note:[/b] Accelerometer sensor doesn't usually require calibration. [b]Note:[/b] This feature is only supported on Windows, Linux, macOS, and iOS.
Starts to vibrate the joypad. See also [method has_joy_vibration] and [method is_joy_vibrating]. Joypads usually come with two rumble motors, a strong and a weak one. [param weak_magnitude] is the strength of the weak motor (between [code]0.0[/code] and [code]1.0[/code]). [param strong_magnitude] is the strength of the strong motor (between [code]0.0[/code] and [code]1.0[/code]). [param duration] is the duration of the effect in seconds (a duration of [code]0.0[/code] will try to play the vibration as long as possible, which is about 65 seconds). The vibration can be stopped early by calling [method stop_joy_vibration]. See also [method get_joy_vibration_strength] and [method get_joy_vibration_duration]. [b]Note:[/b] For macOS, vibration is only supported in macOS 11 and later. When connected via USB, vibration is only supported for major brand controllers (except Xbox One and Xbox Series X/S controllers) due to macOS limitations.
Stops the calibration process of the specified joypad's motion sensors. See [method start_joy_motion_sensors_calibration] for an example on how to use joypad motion sensors and calibration in your games. [b]Note:[/b] This feature is only supported on Windows, Linux, macOS, and iOS.
Stops the vibration of the joypad started with [method start_joy_vibration].
Vibrate the handheld device for the specified duration in milliseconds. [param amplitude] is the strength of the vibration, as a value between [code]0.0[/code] and [code]1.0[/code]. If set to [code]-1.0[/code], the default vibration strength of the device is used. [b]Note:[/b] This method is implemented on Android, iOS, and Web. It has no effect on other platforms. [b]Note:[/b] For Android, [method vibrate_handheld] requires enabling the [code]VIBRATE[/code] permission in the export preset. Otherwise, [method vibrate_handheld] will have no effect. [b]Note:[/b] For iOS, specifying the duration is only supported in iOS 13 and later. [b]Note:[/b] For Web, the amplitude cannot be changed. [b]Note:[/b] Some web browsers such as Safari and Firefox for Android do not support [method vibrate_handheld]. [b]Note:[/b] Device settings such as vibration on/off, "do not disturb" mode or specific haptic feedback on/off may prevent [method vibrate_handheld] effects.
Sets the mouse position to the specified vector, provided in pixels and relative to an origin at the upper left corner of the currently focused Window Manager 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 [constant MOUSE_MODE_CONFINED] or [constant MOUSE_MODE_CONFINED_HIDDEN]. [b]Note:[/b] [method warp_mouse] is only supported on Windows, macOS and Linux. It has no effect on Android, iOS and Web.
- If [code]true[/code], sends mouse input events when tapping or swiping on the touchscreen. See also [member ProjectSettings.input_devices/pointing/emulate_mouse_from_touch].
- If [code]true[/code], sends touch input events when clicking or dragging the mouse. See also [member ProjectSettings.input_devices/pointing/emulate_touch_from_mouse].
- Controls the mouse mode.
- If [code]true[/code], 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. [b]Note:[/b] Input accumulation is [i]enabled[/i] by default.
Emitted when a joypad device has been connected or disconnected.
Makes the mouse cursor visible if it is hidden.
Makes the mouse cursor hidden if it is visible.
Captures the mouse. The mouse will be hidden and its position locked at the center of the window manager's window. [b]Note:[/b] If you want to process the mouse's movement in this mode, you need to use [member InputEventMouseMotion.relative].
Confines the mouse cursor to the game window, and make it visible.
Confines the mouse cursor to the game window, and make it hidden.
Max value of the [enum MouseMode].
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 performed or for selections.
Wait cursor. Indicates that the application is busy performing an operation, and that it cannot be used during the operation (e.g. something is blocking its main thread).
Busy cursor. Indicates that the application is busy performing an operation, and that it is still usable during the operation.
Drag cursor. Usually displayed when dragging something. [b]Note:[/b] Windows lacks a dragging cursor, so [constant CURSOR_DRAG] is the same as [constant CURSOR_MOVE] for this platform.
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 [constant CURSOR_BDIAGSIZE]. 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 [constant CURSOR_VSIZE].
Horizontal split mouse cursor. On Windows, it's the same as [constant CURSOR_HSIZE].
Help cursor. Usually a question mark.