@ringozz/godot 0.1.0

package/gen/classes/Input.ts

@@ -0,0 +1,743 @@
+// Auto-generated from extension_api.json - DO NOT EDIT
+// Generated by dev/codegen.ts
+
+import { _C, _R, GodotVar, _G } from '../../src/runtime.ts';
+import { Object } from './Object.ts';
+import type { JoyAxis, JoyButton, Key, MouseButton, MouseButtonMask } from '../global-enums.ts';
+import type { GodotArray, GodotDictionary, Signal, StringName } from '../heap-types/index.ts';
+import type { Color, Vector2, Vector3 } from '../value-types/index.ts';
+import type { InputEvent } from './InputEvent.ts';
+import type { Resource } from './Resource.ts';
+
+let _$: any;
+const $ = () => _$ ?? (_$ = _C(null, 40, 347));
+
+/**
+ * The {@link 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 {@link InputMap} class.
+ * **Note:** {@link Input}'s methods reflect the global input state and are not affected by {@link Control.acceptEvent} or {@link Viewport.setInputAsHandled}, as those methods only deal with the way input is propagated in the {@link SceneTree}.
+ */
+export class Input extends GodotVar {
+
+    /**
+     * Returns `true` if any action, key, joypad button, or mouse button is being pressed. This will also return `true` if any action is simulated via code by calling {@link actionPress}.
+     */
+    static isAnythingPressed(): boolean { return _C($(), 7762) as boolean; }
+
+    /**
+     * Returns `true` if you are pressing the Latin key in the current keyboard layout. You can pass a {@link Key} constant.
+     * {@link isKeyPressed} is only recommended over {@link isPhysicalKeyPressed} 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 {@link isPhysicalKeyPressed}.
+     * **Note:** Due to keyboard ghosting, {@link isKeyPressed} may return `false` even if one of the action's keys is pressed. See [Input examples]($DOCS_URL/tutorials/inputs/input_examples.html#keyboard-events) in the documentation for more information.
+     * **Note:** If you want to check if a key was just pressed by using its keycode, use Godot's input action system with {@link isActionJustPressed} or use the {@link Node.Input} method like this instead:
+     *
+     *
+     * ```gdscript
+     *
+     * func _input(event):
+     * 	if event is InputEventKey and not event.is_echo() and event.is_pressed() and event.keycode == KEY_SPACE:
+     * 		pass # Your code here.
+     *
+     * ```
+     */
+    static isKeyPressed(keycode: Key): boolean { return _C($(), 8061, keycode) as boolean; }
+
+    /**
+     * Returns `true` if you are pressing the key in the physical location on the 101/102-key US QWERTY keyboard. You can pass a {@link Key} constant.
+     * {@link isPhysicalKeyPressed} is recommended over {@link isKeyPressed} for in-game actions, as it will make `W`/`A`/`S`/`D` layouts work regardless of the user's keyboard layout. {@link isPhysicalKeyPressed} will also ensure that the top row number keys work on any keyboard layout. If in doubt, use {@link isPhysicalKeyPressed}.
+     * **Note:** Due to keyboard ghosting, {@link isPhysicalKeyPressed} may return `false` even if one of the action's keys is pressed. See [Input examples]($DOCS_URL/tutorials/inputs/input_examples.html#keyboard-events) in the documentation for more information.
+     * **Note:** If you want to check if a key was just pressed by using its physical keycode, use Godot's input action system with {@link isActionJustPressed} or use the {@link Node.Input} method like this instead:
+     *
+     *
+     * ```gdscript
+     *
+     * func _input(event):
+     * 	if event is InputEventKey and not event.is_echo() and event.is_pressed() and event.physical_keycode == KEY_SPACE:
+     * 		pass # Your code here.
+     *
+     * ```
+     */
+    static isPhysicalKeyPressed(keycode: Key): boolean { return _C($(), 8175, keycode) as boolean; }
+
+    /**
+     * Returns `true` if you are pressing the key with the `keycode` printed on it. You can pass a {@link Key} constant or any Unicode character code.
+     * **Note:** If you want to check if a key was just pressed by using its label, use Godot's input action system with {@link isActionJustPressed} or use the {@link Node.Input} method like this instead:
+     *
+     *
+     * ```gdscript
+     *
+     * func _input(event):
+     * 	if event is InputEventKey and not event.is_echo() and event.is_pressed() and event.key_label == KEY_SPACE:
+     * 		pass # Your code here.
+     *
+     * ```
+     */
+    static isKeyLabelPressed(keycode: Key): boolean { return _C($(), 8060, keycode) as boolean; }
+
+    /**
+     * Returns `true` if you are pressing the mouse button specified with {@link MouseButton}.
+     * **Note:** If you want to check if a mouse button was just pressed, use Godot's input action system with {@link isActionJustPressed} or use the {@link Node.Input} method like this instead:
+     *
+     *
+     * ```gdscript
+     *
+     * func _input(event):
+     * 	if event is InputEventMouseButton and event.is_pressed() and event.button_index == MOUSE_BUTTON_LEFT:
+     * 		pass # Your code here.
+     *
+     * ```
+     */
+    static isMouseButtonPressed(button: MouseButton): boolean { return _C($(), 8116, button) as boolean; }
+
+    /**
+     * Returns `true` if you are pressing the joypad button at index `button`.
+     * **Note:** If you want to check if a joypad button was just pressed, use Godot's input action system with {@link isActionJustPressed} or use the {@link Node.Input} method like this instead:
+     *
+     *
+     * ```gdscript
+     *
+     * func _input(event):
+     * 	if event is InputEventJoypadButton and event.is_pressed() and event.button_index == JOY_BUTTON_A:
+     * 		pass # Your code here.
+     *
+     * ```
+     */
+    static isJoyButtonPressed(device: number, button: JoyButton): boolean { return _C($(), 8048, device, button) as boolean; }
+
+    /**
+     * Returns `true` if you are pressing the action event.
+     * If `exactMatch` is `false`, it ignores additional input modifiers for {@link InputEventKey} and {@link InputEventMouseButton} events, and the direction for {@link InputEventJoypadMotion} events.
+     * **Note:** Due to keyboard ghosting, {@link isActionPressed} may return `false` even if one of the action's keys is pressed. See [Input examples]($DOCS_URL/tutorials/inputs/input_examples.html#keyboard-events) in the documentation for more information.
+     */
+    static isActionPressed(action: StringName, exactMatch?: boolean /* = false */): boolean { return _C($(), 7742, action, exactMatch) as boolean; }
+
+    /**
+     * Returns `true` when the user has *started* pressing the action event in the current frame or physics tick. It will only return `true` 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 `exactMatch` is `false`, it ignores additional input modifiers for {@link InputEventKey} and {@link InputEventMouseButton} events, and the direction for {@link InputEventJoypadMotion} events.
+     * **Note:** Returning `true` does not imply that the action is *still* pressed. An action can be pressed and released again rapidly, and `true` will still be returned so as not to miss input.
+     * **Note:** Due to keyboard ghosting, {@link isActionJustPressed} may return `false` even if one of the action's keys is pressed. See [Input examples]($DOCS_URL/tutorials/inputs/input_examples.html#keyboard-events) in the documentation for more information.
+     * **Note:** During input handling (e.g. {@link Node.Input}), use {@link InputEvent.isActionPressed} instead to query the action state of the current event. See also {@link isActionJustPressedByEvent}.
+     */
+    static isActionJustPressed(action: StringName, exactMatch?: boolean /* = false */): boolean { return _C($(), 7738, action, exactMatch) as boolean; }
+
+    /**
+     * Returns `true` when the user *stops* pressing the action event in the current frame or physics tick. It will only return `true` on the frame or tick that the user releases the button.
+     * **Note:** Returning `true` does not imply that the action is *still* not pressed. An action can be released and pressed again rapidly, and `true` will still be returned so as not to miss input.
+     * If `exactMatch` is `false`, it ignores additional input modifiers for {@link InputEventKey} and {@link InputEventMouseButton} events, and the direction for {@link InputEventJoypadMotion} events.
+     * **Note:** During input handling (e.g. {@link Node.Input}), use {@link InputEvent.isActionReleased} instead to query the action state of the current event. See also {@link isActionJustReleasedByEvent}.
+     */
+    static isActionJustReleased(action: StringName, exactMatch?: boolean /* = false */): boolean { return _C($(), 7740, action, exactMatch) as boolean; }
+
+    /**
+     * Returns `true` when the user has *started* 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 `event`. It will only return `true` 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. {@link Node.Input}).
+     * If `exactMatch` is `false`, it ignores additional input modifiers for {@link InputEventKey} and {@link InputEventMouseButton} events, and the direction for {@link InputEventJoypadMotion} events.
+     * **Note:** Returning `true` does not imply that the action is *still* pressed. An action can be pressed and released again rapidly, and `true` will still be returned so as not to miss input.
+     * **Note:** Due to keyboard ghosting, {@link isActionJustPressed} may return `false` even if one of the action's keys is pressed. See [Input examples]($DOCS_URL/tutorials/inputs/input_examples.html#keyboard-events) in the documentation for more information.
+     */
+    static isActionJustPressedByEvent(action: StringName, event: InputEvent, exactMatch?: boolean /* = false */): boolean { return _C($(), 7739, action, event, exactMatch) as boolean; }
+
+    /**
+     * Returns `true` when the user *stops* 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 `event`. It will only return `true` on the frame or tick that the user releases the button.
+     * This is useful when an action is processed during input handling (e.g. {@link Node.Input}).
+     * **Note:** Returning `true` does not imply that the action is *still* not pressed. An action can be released and pressed again rapidly, and `true` will still be returned so as not to miss input.
+     * If `exactMatch` is `false`, it ignores additional input modifiers for {@link InputEventKey} and {@link InputEventMouseButton} events, and the direction for {@link InputEventJoypadMotion} events.
+     */
+    static isActionJustReleasedByEvent(action: StringName, event: InputEvent, exactMatch?: boolean /* = false */): boolean { return _C($(), 7741, action, event, exactMatch) as boolean; }
+
+    /**
+     * 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 `exactMatch` is `false`, it ignores additional input modifiers for {@link InputEventKey} and {@link InputEventMouseButton} events, and the direction for {@link InputEventJoypadMotion} events.
+     */
+    static getActionStrength(action: StringName, exactMatch?: boolean /* = false */): number { return _C($(), 3688, action, exactMatch) as number; }
+
+    /**
+     * 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 {@link getActionStrength} instead.
+     * If `exactMatch` is `false`, it ignores additional input modifiers for {@link InputEventKey} and {@link InputEventMouseButton} events, and the direction for {@link InputEventJoypadMotion} events.
+     */
+    static getActionRawStrength(action: StringName, exactMatch?: boolean /* = false */): number { return _C($(), 3683, action, exactMatch) as number; }
+
+    /**
+     * 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")`.
+     */
+    static getAxis(negativeAction: StringName, positiveAction: StringName): number { return _C($(), 3859, negativeAction, positiveAction) as number; }
+
+    /**
+     * 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).
+     */
+    static getVector(negativeX: StringName, positiveX: StringName, negativeY: StringName, positiveY: StringName, deadzone?: number /* = -1.0 */): Vector2 { return _C($(), 7031, negativeX, positiveX, negativeY, positiveY, deadzone) as Vector2; }
+
+    /**
+     * Adds a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices.
+     */
+    static addJoyMapping(mapping: string, updateExisting?: boolean /* = false */): void { _C($(), 1242, mapping, updateExisting); }
+
+    /**
+     * 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.
+     */
+    static removeJoyMapping(guid: string): void { _C($(), 9925, guid); }
+
+    /**
+     * Returns `true` 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.
+     */
+    static isJoyKnown(device: number): boolean { return _C($(), 8049, device) as boolean; }
+
+    /**
+     * Returns the current value of the joypad axis at index `axis`.
+     */
+    static getJoyAxis(device: number, axis: JoyAxis): number { return _C($(), 5264, device, axis) as number; }
+
+    /**
+     * Returns the name of the joypad at the specified device index, e.g. `PS4 Controller`. Godot uses the [SDL2 game controller database](https://github.com/gabomdq/SDL_GameControllerDB) to determine gamepad names.
+     */
+    static getJoyName(device: number): string { return _C($(), 5271, device) as string; }
+
+    /**
+     * Returns an SDL-compatible device GUID on platforms that use gamepad remapping, e.g. `030000004c050000c405000000010000`. 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 `__XINPUT_DEVICE__`, because their mappings are the same.
+     */
+    static getJoyGuid(device: number): string { return _C($(), 5266, device) as string; }
+
+    /**
+     * 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:
+     * `raw_name`: The name of the controller as it came from the OS, before getting renamed by the controller database.
+     * `vendor_id`: The USB vendor ID of the device.
+     * `product_id`: The USB product ID of the device.
+     * `serial_number`: 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:
+     * `steam_input_index`: 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.
+     * `xinput_index`: The index of the controller in the XInput system (Windows only). This key won't be present for devices not handled by XInput.
+     * **Note:** The returned dictionary is always empty on Android and Web.
+     */
+    static getJoyInfo(device: number): GodotDictionary { return _C($(), 5268, device) as GodotDictionary; }
+
+    /**
+     * Queries whether an input device should be ignored or not. Devices can be ignored by setting the environment variable `SDL_GAMECONTROLLER_IGNORE_DEVICES`. Read the [SDL documentation](https://wiki.libsdl.org/SDL2) for more information.
+     * **Note:** Some 3rd party tools can contribute to the list of ignored devices. For example, *SteamInput* 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.
+     */
+    static shouldIgnoreDevice(vendorId: number, productId: number): boolean { return _C($(), 13572, vendorId, productId) as boolean; }
+
+    /**
+     * Returns an {@link Array} containing the device IDs of all currently connected joypads.
+     * **Note:** The order of connected joypads can not be guaranteed to be the same after a project and/or the editor is restarted, because Godot doesn't save the order of joypad connections. Joypads are registered in the order they are discovered by Godot.
+     */
+    static getConnectedJoypads(): GodotArray<number> { return _C($(), 4261) as GodotArray<number>; }
+
+    /**
+     * Returns the strength of the joypad vibration: x is the strength of the weak motor, and y is the strength of the strong motor.
+     * **Note:** This method returns the same values that were passed to {@link startJoyVibration}, and these values do **not** change when the joypad's vibration runs out, they only get reset after a call to {@link stopJoyVibration}.
+     * If you want to check if a joypad is still vibrating, use {@link isJoyVibrating} instead.
+     */
+    static getJoyVibrationStrength(device: number): Vector2 { return _C($(), 5274, device) as Vector2; }
+
+    /**
+     * Returns the duration of the current vibration effect in seconds.
+     * **Note:** This method returns the same value that was passed to {@link startJoyVibration}, and this value does **not** change when the joypad's vibration runs out, it only gets reset after a call to {@link stopJoyVibration}.
+     * If you want to check if a joypad is still vibrating, use {@link isJoyVibrating} instead.
+     */
+    static getJoyVibrationDuration(device: number): number { return _C($(), 5272, device) as number; }
+
+    /**
+     * Returns the remaining duration of the current vibration effect in seconds.
+     */
+    static getJoyVibrationRemainingDuration(device: number): number { return _C($(), 5273, device) as number; }
+
+    /**
+     * Returns `true` if the joypad is still vibrating after a call to {@link startJoyVibration}.
+     * Unlike {@link getJoyVibrationStrength} and {@link getJoyVibrationDuration}, this method returns `false` after the joypad's vibration runs out.
+     */
+    static isJoyVibrating(device: number): boolean { return _C($(), 8053, device) as boolean; }
+
+    /**
+     * Returns `true` if the joypad supports vibration. See also {@link startJoyVibration}.
+     * **Note:** 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.
+     */
+    static hasJoyVibration(device: number): boolean { return _C($(), 7409, device) as boolean; }
+
+    /**
+     * Starts to vibrate the joypad. See also {@link hasJoyVibration} and {@link isJoyVibrating}.
+     * Joypads usually come with two rumble motors, a strong and a weak one.
+     * `weakMagnitude` is the strength of the weak motor (between `0.0` and `1.0`).
+     * `strongMagnitude` is the strength of the strong motor (between `0.0` and `1.0`).
+     * `duration` is the duration of the effect in seconds (a duration of `0.0` will try to play the vibration as long as possible, which is about 65 seconds).
+     * The vibration can be stopped early by calling {@link stopJoyVibration}.
+     * See also {@link getJoyVibrationStrength} and {@link getJoyVibrationDuration}.
+     * **Note:** 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.
+     */
+    static startJoyVibration(device: number, weakMagnitude: number, strongMagnitude: number, duration?: number /* = 0 */): void { _C($(), 13839, device, weakMagnitude, strongMagnitude, duration); }
+
+    /**
+     * Stops the vibration of the joypad started with {@link startJoyVibration}.
+     */
+    static stopJoyVibration(device: number): void { _C($(), 13868, device); }
+
+    /**
+     * Vibrate the handheld device for the specified duration in milliseconds.
+     * `amplitude` is the strength of the vibration, as a value between `0.0` and `1.0`. If set to `-1.0`, the default vibration strength of the device is used.
+     * **Note:** This method is implemented on Android, iOS, and Web. It has no effect on other platforms.
+     * **Note:** For Android, {@link vibrateHandheld} requires enabling the `VIBRATE` permission in the export preset. Otherwise, {@link vibrateHandheld} will have no effect.
+     * **Note:** For iOS, specifying the duration is only supported in iOS 13 and later.
+     * **Note:** For Web, the amplitude cannot be changed.
+     * **Note:** Some web browsers such as Safari and Firefox for Android do not support {@link vibrateHandheld}.
+     * **Note:** Device settings such as vibration on/off, "do not disturb" mode or specific haptic feedback on/off may prevent {@link vibrateHandheld} effects.
+     */
+    static vibrateHandheld(durationMs?: number /* = 500 */, amplitude?: number /* = -1.0 */): void { _C($(), 14709, durationMs, amplitude); }
+
+    /**
+     * Returns the gravity in m/s² of the device's accelerometer sensor, if the device has one. Otherwise, the method returns {@link Vector3.ZERO}.
+     * **Note:** This method only works on Android and iOS. On other platforms, it always returns {@link Vector3.ZERO}.
+     * **Note:** For Android, {@link ProjectSettings.inputDevices/sensors/enableGravity} must be enabled.
+     */
+    static getGravity(): Vector3 { return _C($(), 4971) as Vector3; }
+
+    /**
+     * Returns the acceleration in m/s² of the device's accelerometer sensor, if the device has one. Otherwise, the method returns {@link Vector3.ZERO}.
+     * Note this method returns an empty {@link 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 Android and iOS. On other platforms, it always returns {@link Vector3.ZERO}.
+     * **Note:** For Android, {@link ProjectSettings.inputDevices/sensors/enableAccelerometer} must be enabled.
+     */
+    static getAccelerometer(): Vector3 { return _C($(), 3660) as Vector3; }
+
+    /**
+     * 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 {@link Vector3.ZERO}.
+     * **Note:** This method only works on Android and iOS. On other platforms, it always returns {@link Vector3.ZERO}.
+     * **Note:** For Android, {@link ProjectSettings.inputDevices/sensors/enableMagnetometer} must be enabled.
+     */
+    static getMagnetometer(): Vector3 { return _C($(), 5430) as Vector3; }
+
+    /**
+     * 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 {@link Vector3.ZERO}.
+     * **Note:** This method only works on Android and iOS. On other platforms, it always returns {@link Vector3.ZERO}.
+     * **Note:** For Android, {@link ProjectSettings.inputDevices/sensors/enableGyroscope} must be enabled.
+     */
+    static getGyroscope(): Vector3 { return _C($(), 4998) as Vector3; }
+
+    /**
+     * 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 {@link Vector3.ZERO}. See also {@link getJoyGravity} and {@link setJoyMotionSensorsEnabled}.
+     * 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 `9.8` away from the center of the Earth, which is a negative Y value.
+     * **Note:** This feature is only supported on Windows, Linux, and macOS. On iOS, joypad accelerometer sensor reading is not supported due to OS limitations.
+     */
+    static getJoyAccelerometer(device: number): Vector3 { return _C($(), 5263, device) as Vector3; }
+
+    /**
+     * 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 {@link Vector3.ZERO}. See also {@link getJoyAccelerometer} and {@link setJoyMotionSensorsEnabled}.
+     * 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 `9.8` away from the center of the Earth, which is a negative Y value.
+     * **Note:** This feature is only supported on Windows, Linux, and macOS. On iOS, joypad accelerometer sensor reading is not supported due to OS limitations.
+     */
+    static getJoyGravity(device: number): Vector3 { return _C($(), 5265, device) as Vector3; }
+
+    /**
+     * 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 {@link Vector3.ZERO}. See also {@link setJoyMotionSensorsEnabled}.
+     * 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 {@link startJoyMotionSensorsCalibration} for an example on how to use joypad gyroscope and gyroscope calibration in your games.
+     * **Note:** This feature is only supported on Windows, Linux, macOS, and iOS.
+     */
+    static getJoyGyroscope(device: number): Vector3 { return _C($(), 5267, device) as Vector3; }
+
+    /**
+     * Returns the joypad's motion sensor rate in Hz, if the joypad has motion sensors and they're currently enabled. See also {@link setJoyMotionSensorsEnabled}.
+     * **Note:** This feature is only supported on Windows, Linux, macOS, and iOS.
+     */
+    static getJoyMotionSensorsRate(device: number): number { return _C($(), 5270, device) as number; }
+
+    /**
+     * Returns `true` if the requested joypad has motion sensors (accelerometer and gyroscope) and they are currently enabled. See also {@link setJoyMotionSensorsEnabled} and {@link hasJoyMotionSensors}.
+     * See {@link startJoyMotionSensorsCalibration} for an example on how to use joypad motion sensors and calibration in your games.
+     * **Note:** This feature is only supported on Windows, Linux, macOS, and iOS.
+     */
+    static isJoyMotionSensorsEnabled(device: number): boolean { return _C($(), 8052, device) as boolean; }
+
+    /**
+     * Enables or disables the motion sensors (accelerometer and gyroscope), if available, on the specified joypad.
+     * See {@link startJoyMotionSensorsCalibration} 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.
+     * **Note:** This feature is only supported on Windows, Linux, macOS, and iOS.
+     */
+    static setJoyMotionSensorsEnabled(device: number, enable: boolean): void { _C($(), 11847, device, enable); }
+
+    /**
+     * Returns `true` if the joypad has motion sensors (accelerometer and gyroscope).
+     * **Note:** On iOS, joypad accelerometer sensor reading is not supported due to OS limitations.
+     * **Note:** This feature is only supported on Windows, Linux, macOS, and iOS.
+     */
+    static hasJoyMotionSensors(device: number): boolean { return _C($(), 7408, device) as boolean; }
+
+    /**
+     * 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), {@link getJoyGyroscope} will return values close or equal to {@link 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:
+     *
+     *
+     * ```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.
+     *
+     * ```
+     *
+     *
+     *
+     * **Note:** Accelerometer sensor doesn't usually require calibration.
+     * **Note:** This feature is only supported on Windows, Linux, macOS, and iOS.
+     */
+    static startJoyMotionSensorsCalibration(device: number): void { _C($(), 13838, device); }
+
+    /**
+     * Stops the calibration process of the specified joypad's motion sensors.
+     * See {@link startJoyMotionSensorsCalibration} for an example on how to use joypad motion sensors and calibration in your games.
+     * **Note:** This feature is only supported on Windows, Linux, macOS, and iOS.
+     */
+    static stopJoyMotionSensorsCalibration(device: number): void { _C($(), 13867, device); }
+
+    /**
+     * Clears the calibration information for the specified joypad's motion sensors, if it has any and if they were calibrated.
+     * See {@link startJoyMotionSensorsCalibration} for an example on how to use joypad motion sensors and calibration in your games.
+     * **Note:** This feature is only supported on Windows, Linux, macOS, and iOS.
+     */
+    static clearJoyMotionSensorsCalibration(device: number): void { _C($(), 2277, device); }
+
+    /**
+     * Returns the calibration information about the specified joypad's motion sensors in the form of a {@link Dictionary}, if it has any and if they have been calibrated, otherwise returns an empty {@link Dictionary}.
+     * The dictionary contains the following fields:
+     * `gyroscope_offset`: average offset in gyroscope values from {@link Vector2.ZERO} in rad/s.
+     * See {@link startJoyMotionSensorsCalibration} for an example on how to use joypad motion sensors and calibration in your games.
+     * **Note:** This feature is only supported on Windows, Linux, macOS, and iOS.
+     */
+    static getJoyMotionSensorsCalibration(device: number): GodotDictionary { return _C($(), 5269, device) as GodotDictionary; }
+
+    /**
+     * Sets the specified joypad's calibration information. See also {@link getJoyMotionSensorsCalibration}.
+     * See {@link startJoyMotionSensorsCalibration} for an example on how to use joypad motion sensors and calibration in your games.
+     * **Note:** This feature is only supported on Windows, Linux, macOS, and iOS.
+     */
+    static setJoyMotionSensorsCalibration(device: number, calibrationInfo: GodotDictionary): void { _C($(), 11846, device, calibrationInfo); }
+
+    /**
+     * Returns `true` if the joypad's motion sensors have been calibrated.
+     * See {@link startJoyMotionSensorsCalibration} for an example on how to use joypad motion sensors and calibration in your games.
+     * **Note:** This feature is only supported on Windows, Linux, macOS, and iOS.
+     */
+    static isJoyMotionSensorsCalibrated(device: number): boolean { return _C($(), 8050, device) as boolean; }
+
+    /**
+     * Returns `true` if the joypad's motion sensors are currently being calibrated.
+     * See {@link startJoyMotionSensorsCalibration} for an example on how to use joypad motion sensors and calibration in your games.
+     * **Note:** This feature is only supported on Windows, Linux, macOS, and iOS.
+     */
+    static isJoyMotionSensorsCalibrating(device: number): boolean { return _C($(), 8051, device) as boolean; }
+
+    /**
+     * 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.
+     * **Note:** This value can be immediately overwritten by the hardware sensor value on Android and iOS.
+     */
+    static setGravity(value: Vector3): void { _C($(), 11553, value); }
+
+    /**
+     * 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.
+     * **Note:** This value can be immediately overwritten by the hardware sensor value on Android and iOS.
+     */
+    static setAccelerometer(value: Vector3): void { _C($(), 10399, value); }
+
+    /**
+     * 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.
+     * **Note:** This value can be immediately overwritten by the hardware sensor value on Android and iOS.
+     */
+    static setMagnetometer(value: Vector3): void { _C($(), 11962, value); }
+
+    /**
+     * 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.
+     * **Note:** This value can be immediately overwritten by the hardware sensor value on Android and iOS.
+     */
+    static setGyroscope(value: Vector3): void { _C($(), 11583, value); }
+
+    /**
+     * Sets the joypad's LED light, if available, to the specified color. See also {@link hasJoyLight}.
+     * **Note:** 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.
+     * **Note:** This feature is only supported on Windows, Linux, macOS, and iOS.
+     */
+    static setJoyLight(device: number, color: Color): void { _C($(), 11845, device, color); }
+
+    /**
+     * Returns `true` if the joypad has an LED light that can change colors and/or brightness. See also {@link setJoyLight}.
+     * **Note:** This feature is only supported on Windows, Linux, macOS, and iOS.
+     */
+    static hasJoyLight(device: number): boolean { return _C($(), 7407, device) as boolean; }
+
+    /**
+     * 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.
+     */
+    static getLastMouseVelocity(): Vector2 { return _C($(), 5308) as Vector2; }
+
+    /**
+     * 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.
+     */
+    static getLastMouseScreenVelocity(): Vector2 { return _C($(), 5307) as Vector2; }
+
+    /**
+     * Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the same time, the bits are added together. Equivalent to {@link DisplayServer.mouseGetButtonState}.
+     */
+    static getMouseButtonMask(): MouseButtonMask { return _C($(), 5586) as MouseButtonMask; }
+
+    /**
+     * 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 {@link MouseMode} is set to {@link MOUSE_MODE_CONFINED} or {@link MOUSE_MODE_CONFINED_HIDDEN}.
+     * **Note:** {@link warpMouse} is only supported on Windows, macOS and Linux. It has no effect on Android, iOS and Web.
+     */
+    static warpMouse(position: Vector2): void { _C($(), 14840, position); }
+
+    /**
+     * 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 {@link Node.Input} calls. It is intended to be used with {@link isActionPressed} and {@link isActionJustPressed}. If you want to simulate `_input`, use {@link parseInputEvent} instead.
+     */
+    static actionPress(action: StringName, strength?: number /* = 1.0 */): void { _C($(), 1165, action, strength); }
+
+    /**
+     * If the specified action is already pressed, this will release it.
+     */
+    static actionRelease(action: StringName): void { _C($(), 1166, action); }
+
+    /**
+     * Sets the default cursor shape to be used in the viewport instead of {@link CURSOR_ARROW}.
+     * **Note:** If you want to change the default cursor shape for {@link Control}'s nodes, use {@link Control.mouseDefaultCursorShape} instead.
+     * **Note:** This method generates an {@link InputEventMouseMotion} to update cursor immediately.
+     */
+    static setDefaultCursorShape(shape?: CursorShape /* = 0 */): void { _C($(), 11060, shape); }
+
+    /**
+     * Returns the currently assigned cursor shape.
+     */
+    static getCurrentCursorShape(): CursorShape { return _C($(), 4348) as CursorShape; }
+
+    /**
+     * Sets a custom mouse cursor image, which is only visible inside the game window, for the given mouse `shape`. The hotspot can also be specified. Passing `null` to the image parameter resets to the system cursor.
+     * `image` can be either {@link Texture2D} or {@link 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.
+     * `hotspot` must be within `image`'s size.
+     * **Note:** {@link AnimatedTexture}s aren't supported as custom mouse cursors. If using an {@link AnimatedTexture}, only the first frame will be displayed.
+     * **Note:** The **Lossless**, **Lossy** or **Uncompressed** compression modes are recommended. The **Video RAM** 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.
+     * **Note:** 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 [security reasons](https://chromestatus.com/feature/5825971391299584).
+     */
+    static setCustomMouseCursor(image: Resource, shape?: CursorShape /* = 0 */, hotspot?: Vector2 /* = Vector2(0, 0) */): void { _C($(), 11018, image, shape, hotspot); }
+
+    /**
+     * Feeds an {@link InputEvent} to the game. Can be used to artificially trigger input events from code. Also generates {@link Node.Input} calls.
+     *
+     *
+     * ```gdscript
+     *
+     * var cancel_event = InputEventAction.new()
+     * cancel_event.action = "ui_cancel"
+     * cancel_event.pressed = true
+     * Input.parse_input_event(cancel_event)
+     *
+     * ```
+     *
+     *
+     *
+     * **Note:** Calling this function has no influence on the operating system. So for example sending an {@link InputEventMouseMotion} will not move the OS mouse cursor to the specified position (use {@link warpMouse} instead) and sending `Alt/Cmd + Tab` as {@link InputEventKey} won't toggle between active windows.
+     */
+    static parseInputEvent(event: InputEvent): void { _C($(), 9280, event); }
+
+    /**
+     * 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 ({@link useAccumulatedInput}) or agile input flushing ({@link ProjectSettings.inputDevices/buffering/agileEventFlushing}).
+     * 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.
+     */
+    static flushBufferedEvents(): void { _C($(), 3344); }
+
+    /**
+     * Controls the mouse mode.
+     */
+    static get mouseMode(): MouseMode { return _C($(), 5589) as MouseMode; }
+    static set mouseMode(v: MouseMode) { _C($(), 12095, v); }
+
+    /**
+     * 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.
+     */
+    static get useAccumulatedInput(): boolean { return _C($(), 8392) as boolean; }
+    static set useAccumulatedInput(v: boolean) { _C($(), 13192, v); }
+
+    /**
+     * If `true`, sends mouse input events when tapping or swiping on the touchscreen. See also {@link ProjectSettings.inputDevices/pointing/emulateMouseFromTouch}.
+     */
+    static get emulateMouseFromTouch(): boolean { return _C($(), 7933) as boolean; }
+    static set emulateMouseFromTouch(v: boolean) { _C($(), 11260, v); }
+
+    /**
+     * If `true`, sends touch input events when clicking or dragging the mouse. See also {@link ProjectSettings.inputDevices/pointing/emulateTouchFromMouse}.
+     */
+    static get emulateTouchFromMouse(): boolean { return _C($(), 7934) as boolean; }
+    static set emulateTouchFromMouse(v: boolean) { _C($(), 11261, v); }
+
+    /**
+     * If `true`, joypad input (including motion sensors) and LED light changes will be ignored and joypad vibration will be stopped when the application is not focused.
+     */
+    static get ignoreJoypadOnUnfocusedApplication(): boolean { return _C($(), 8004) as boolean; }
+    static set ignoreJoypadOnUnfocusedApplication(v: boolean) { _C($(), 11664, v); }
+
+    /**
+     * Emitted when a joypad device has been connected or disconnected.
+     */
+    static get joyConnectionChanged(): Signal<(device: number, connected: boolean) => void> { return _G($(), 8501) as Signal<(device: number, connected: boolean) => void>; }
+    static set joyConnectionChanged(v: ((device: number, connected: boolean) => void) | null) { _G($(), 8501, v); }
+
+    static readonly name = _R(347, Input);
+}
+
+export const MouseMode = {
+    /**
+     * Makes the mouse cursor visible if it is hidden.
+     */
+    MOUSE_MODE_VISIBLE: 0,
+    /**
+     * Makes the mouse cursor hidden if it is visible.
+     */
+    MOUSE_MODE_HIDDEN: 1,
+    /**
+     * 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 {@link InputEventMouseMotion.relative}.
+     */
+    MOUSE_MODE_CAPTURED: 2,
+    /**
+     * Confines the mouse cursor to the game window, and make it visible.
+     */
+    MOUSE_MODE_CONFINED: 3,
+    /**
+     * Confines the mouse cursor to the game window, and make it hidden.
+     */
+    MOUSE_MODE_CONFINED_HIDDEN: 4,
+    /**
+     * Max value of the {@link MouseMode}.
+     */
+    MOUSE_MODE_MAX: 5,
+} as const;
+
+export type MouseMode = (typeof MouseMode)[keyof typeof MouseMode];
+
+export const CursorShape = {
+    /**
+     * Arrow cursor. Standard, default pointing cursor.
+     */
+    CURSOR_ARROW: 0,
+    /**
+     * I-beam cursor. Usually used to show where the text cursor will appear when the mouse is clicked.
+     */
+    CURSOR_IBEAM: 1,
+    /**
+     * Pointing hand cursor. Usually used to indicate the pointer is over a link or other interactable item.
+     */
+    CURSOR_POINTING_HAND: 2,
+    /**
+     * Cross cursor. Typically appears over regions in which a drawing operation can be performed or for selections.
+     */
+    CURSOR_CROSS: 3,
+    /**
+     * 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).
+     */
+    CURSOR_WAIT: 4,
+    /**
+     * Busy cursor. Indicates that the application is busy performing an operation, and that it is still usable during the operation.
+     */
+    CURSOR_BUSY: 5,
+    /**
+     * Drag cursor. Usually displayed when dragging something.
+     * **Note:** Windows lacks a dragging cursor, so {@link CURSOR_DRAG} is the same as {@link CURSOR_MOVE} for this platform.
+     */
+    CURSOR_DRAG: 6,
+    /**
+     * Can drop cursor. Usually displayed when dragging something to indicate that it can be dropped at the current position.
+     */
+    CURSOR_CAN_DROP: 7,
+    /**
+     * Forbidden cursor. Indicates that the current action is forbidden (for example, when dragging something) or that the control at a position is disabled.
+     */
+    CURSOR_FORBIDDEN: 8,
+    /**
+     * Vertical resize mouse cursor. A double-headed vertical arrow. It tells the user they can resize the window or the panel vertically.
+     */
+    CURSOR_VSIZE: 9,
+    /**
+     * Horizontal resize mouse cursor. A double-headed horizontal arrow. It tells the user they can resize the window or the panel horizontally.
+     */
+    CURSOR_HSIZE: 10,
+    /**
+     * 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.
+     */
+    CURSOR_BDIAGSIZE: 11,
+    /**
+     * Window resize mouse cursor. The cursor is a double-headed arrow that goes from the top left to the bottom right, the opposite of {@link CURSOR_BDIAGSIZE}. It tells the user they can resize the window or the panel both horizontally and vertically.
+     */
+    CURSOR_FDIAGSIZE: 12,
+    /**
+     * Move cursor. Indicates that something can be moved.
+     */
+    CURSOR_MOVE: 13,
+    /**
+     * Vertical split mouse cursor. On Windows, it's the same as {@link CURSOR_VSIZE}.
+     */
+    CURSOR_VSPLIT: 14,
+    /**
+     * Horizontal split mouse cursor. On Windows, it's the same as {@link CURSOR_HSIZE}.
+     */
+    CURSOR_HSPLIT: 15,
+    /**
+     * Help cursor. Usually a question mark.
+     */
+    CURSOR_HELP: 16,
+} as const;
+
+export type CursorShape = (typeof CursorShape)[keyof typeof CursorShape];
+