513 lines
33 KiB
XML
513 lines
33 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
||
<class name="Input" inherits="Object" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
||
<brief_description>
|
||
A singleton for handling inputs.
|
||
</brief_description>
|
||
<description>
|
||
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].
|
||
</description>
|
||
<tutorials>
|
||
<link title="Inputs documentation index">$DOCS_URL/tutorials/inputs/index.html</link>
|
||
<link title="2D Dodge The Creeps Demo">https://godotengine.org/asset-library/asset/515</link>
|
||
<link title="3D Voxel Demo">https://godotengine.org/asset-library/asset/676</link>
|
||
</tutorials>
|
||
<methods>
|
||
<method name="action_press">
|
||
<return type="void" />
|
||
<param index="0" name="action" type="StringName" />
|
||
<param index="1" name="strength" type="float" default="1.0" />
|
||
<description>
|
||
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.
|
||
</description>
|
||
</method>
|
||
<method name="action_release">
|
||
<return type="void" />
|
||
<param index="0" name="action" type="StringName" />
|
||
<description>
|
||
If the specified action is already pressed, this will release it.
|
||
</description>
|
||
</method>
|
||
<method name="add_joy_mapping">
|
||
<return type="void" />
|
||
<param index="0" name="mapping" type="String" />
|
||
<param index="1" name="update_existing" type="bool" default="false" />
|
||
<description>
|
||
Adds a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices.
|
||
</description>
|
||
</method>
|
||
<method name="flush_buffered_events">
|
||
<return type="void" />
|
||
<description>
|
||
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.
|
||
</description>
|
||
</method>
|
||
<method name="get_accelerometer" qualifiers="const">
|
||
<return type="Vector3" />
|
||
<description>
|
||
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].
|
||
</description>
|
||
</method>
|
||
<method name="get_action_raw_strength" qualifiers="const">
|
||
<return type="float" />
|
||
<param index="0" name="action" type="StringName" />
|
||
<param index="1" name="exact_match" type="bool" default="false" />
|
||
<description>
|
||
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.
|
||
</description>
|
||
</method>
|
||
<method name="get_action_strength" qualifiers="const">
|
||
<return type="float" />
|
||
<param index="0" name="action" type="StringName" />
|
||
<param index="1" name="exact_match" type="bool" default="false" />
|
||
<description>
|
||
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.
|
||
</description>
|
||
</method>
|
||
<method name="get_axis" qualifiers="const">
|
||
<return type="float" />
|
||
<param index="0" name="negative_action" type="StringName" />
|
||
<param index="1" name="positive_action" type="StringName" />
|
||
<description>
|
||
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].
|
||
</description>
|
||
</method>
|
||
<method name="get_connected_joypads">
|
||
<return type="int[]" />
|
||
<description>
|
||
Returns an [Array] containing the device IDs of all currently connected joypads.
|
||
</description>
|
||
</method>
|
||
<method name="get_current_cursor_shape" qualifiers="const">
|
||
<return type="int" enum="Input.CursorShape" />
|
||
<description>
|
||
Returns the currently assigned cursor shape (see [enum CursorShape]).
|
||
</description>
|
||
</method>
|
||
<method name="get_gravity" qualifiers="const">
|
||
<return type="Vector3" />
|
||
<description>
|
||
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].
|
||
</description>
|
||
</method>
|
||
<method name="get_gyroscope" qualifiers="const">
|
||
<return type="Vector3" />
|
||
<description>
|
||
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].
|
||
</description>
|
||
</method>
|
||
<method name="get_joy_axis" qualifiers="const">
|
||
<return type="float" />
|
||
<param index="0" name="device" type="int" />
|
||
<param index="1" name="axis" type="int" enum="JoyAxis" />
|
||
<description>
|
||
Returns the current value of the joypad axis at given index (see [enum JoyAxis]).
|
||
</description>
|
||
</method>
|
||
<method name="get_joy_guid" qualifiers="const">
|
||
<return type="String" />
|
||
<param index="0" name="device" type="int" />
|
||
<description>
|
||
Returns a SDL2-compatible device GUID on platforms that use gamepad remapping, e.g. [code]030000004c050000c405000000010000[/code]. Returns [code]"Default Gamepad"[/code] otherwise. Godot uses the [url=https://github.com/gabomdq/SDL_GameControllerDB]SDL2 game controller database[/url] to determine gamepad names and mappings based on this GUID.
|
||
</description>
|
||
</method>
|
||
<method name="get_joy_info" qualifiers="const">
|
||
<return type="Dictionary" />
|
||
<param index="0" name="device" type="int" />
|
||
<description>
|
||
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 the dictionary contains the following fields:
|
||
[code]xinput_index[/code]: The index of the controller in the XInput system.
|
||
On Linux:
|
||
[code]raw_name[/code]: The name of the controller as it came from the OS, before getting renamed by the godot 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]steam_input_index[/code]: The Steam Input gamepad index, if the device is not a Steam Input device this key won't be present.
|
||
</description>
|
||
</method>
|
||
<method name="get_joy_name">
|
||
<return type="String" />
|
||
<param index="0" name="device" type="int" />
|
||
<description>
|
||
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.
|
||
</description>
|
||
</method>
|
||
<method name="get_joy_vibration_duration">
|
||
<return type="float" />
|
||
<param index="0" name="device" type="int" />
|
||
<description>
|
||
Returns the duration of the current vibration effect in seconds.
|
||
</description>
|
||
</method>
|
||
<method name="get_joy_vibration_strength">
|
||
<return type="Vector2" />
|
||
<param index="0" name="device" type="int" />
|
||
<description>
|
||
Returns the strength of the joypad vibration: x is the strength of the weak motor, and y is the strength of the strong motor.
|
||
</description>
|
||
</method>
|
||
<method name="get_last_mouse_screen_velocity">
|
||
<return type="Vector2" />
|
||
<description>
|
||
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.
|
||
</description>
|
||
</method>
|
||
<method name="get_last_mouse_velocity">
|
||
<return type="Vector2" />
|
||
<description>
|
||
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.
|
||
</description>
|
||
</method>
|
||
<method name="get_magnetometer" qualifiers="const">
|
||
<return type="Vector3" />
|
||
<description>
|
||
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].
|
||
</description>
|
||
</method>
|
||
<method name="get_mouse_button_mask" qualifiers="const">
|
||
<return type="int" enum="MouseButtonMask" is_bitfield="true" />
|
||
<description>
|
||
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].
|
||
</description>
|
||
</method>
|
||
<method name="get_vector" qualifiers="const">
|
||
<return type="Vector2" />
|
||
<param index="0" name="negative_x" type="StringName" />
|
||
<param index="1" name="positive_x" type="StringName" />
|
||
<param index="2" name="negative_y" type="StringName" />
|
||
<param index="3" name="positive_y" type="StringName" />
|
||
<param index="4" name="deadzone" type="float" default="-1.0" />
|
||
<description>
|
||
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).
|
||
</description>
|
||
</method>
|
||
<method name="is_action_just_pressed" qualifiers="const">
|
||
<return type="bool" />
|
||
<param index="0" name="action" type="StringName" />
|
||
<param index="1" name="exact_match" type="bool" default="false" />
|
||
<description>
|
||
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.
|
||
</description>
|
||
</method>
|
||
<method name="is_action_just_released" qualifiers="const">
|
||
<return type="bool" />
|
||
<param index="0" name="action" type="StringName" />
|
||
<param index="1" name="exact_match" type="bool" default="false" />
|
||
<description>
|
||
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.
|
||
</description>
|
||
</method>
|
||
<method name="is_action_pressed" qualifiers="const">
|
||
<return type="bool" />
|
||
<param index="0" name="action" type="StringName" />
|
||
<param index="1" name="exact_match" type="bool" default="false" />
|
||
<description>
|
||
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.
|
||
</description>
|
||
</method>
|
||
<method name="is_anything_pressed" qualifiers="const">
|
||
<return type="bool" />
|
||
<description>
|
||
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].
|
||
</description>
|
||
</method>
|
||
<method name="is_joy_button_pressed" qualifiers="const" keywords="is_gamepad_button_pressed, is_controller_button_pressed">
|
||
<return type="bool" />
|
||
<param index="0" name="device" type="int" />
|
||
<param index="1" name="button" type="int" enum="JoyButton" />
|
||
<description>
|
||
Returns [code]true[/code] if you are pressing the joypad button (see [enum JoyButton]).
|
||
</description>
|
||
</method>
|
||
<method name="is_joy_known" keywords="is_gamepad_known, is_controller_known">
|
||
<return type="bool" />
|
||
<param index="0" name="device" type="int" />
|
||
<description>
|
||
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.
|
||
</description>
|
||
</method>
|
||
<method name="is_key_label_pressed" qualifiers="const">
|
||
<return type="bool" />
|
||
<param index="0" name="keycode" type="int" enum="Key" />
|
||
<description>
|
||
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.
|
||
</description>
|
||
</method>
|
||
<method name="is_key_pressed" qualifiers="const">
|
||
<return type="bool" />
|
||
<param index="0" name="keycode" type="int" enum="Key" />
|
||
<description>
|
||
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.
|
||
</description>
|
||
</method>
|
||
<method name="is_mouse_button_pressed" qualifiers="const">
|
||
<return type="bool" />
|
||
<param index="0" name="button" type="int" enum="MouseButton" />
|
||
<description>
|
||
Returns [code]true[/code] if you are pressing the mouse button specified with [enum MouseButton].
|
||
</description>
|
||
</method>
|
||
<method name="is_physical_key_pressed" qualifiers="const">
|
||
<return type="bool" />
|
||
<param index="0" name="keycode" type="int" enum="Key" />
|
||
<description>
|
||
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.
|
||
</description>
|
||
</method>
|
||
<method name="parse_input_event">
|
||
<return type="void" />
|
||
<param index="0" name="event" type="InputEvent" />
|
||
<description>
|
||
Feeds an [InputEvent] to the game. Can be used to artificially trigger input events from code. Also generates [method Node._input] calls.
|
||
[b]Example:[/b]
|
||
[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.
|
||
</description>
|
||
</method>
|
||
<method name="remove_joy_mapping">
|
||
<return type="void" />
|
||
<param index="0" name="guid" type="String" />
|
||
<description>
|
||
Removes all mappings from the internal database that match the given GUID.
|
||
</description>
|
||
</method>
|
||
<method name="set_accelerometer">
|
||
<return type="void" />
|
||
<param index="0" name="value" type="Vector3" />
|
||
<description>
|
||
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.
|
||
</description>
|
||
</method>
|
||
<method name="set_custom_mouse_cursor">
|
||
<return type="void" />
|
||
<param index="0" name="image" type="Resource" />
|
||
<param index="1" name="shape" type="int" enum="Input.CursorShape" default="0" />
|
||
<param index="2" name="hotspot" type="Vector2" default="Vector2(0, 0)" />
|
||
<description>
|
||
Sets a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified. Passing [code]null[/code] to the image parameter resets to the system cursor. See [enum CursorShape] for the list of shapes.
|
||
[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].
|
||
</description>
|
||
</method>
|
||
<method name="set_default_cursor_shape">
|
||
<return type="void" />
|
||
<param index="0" name="shape" type="int" enum="Input.CursorShape" default="0" />
|
||
<description>
|
||
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.
|
||
</description>
|
||
</method>
|
||
<method name="set_gravity">
|
||
<return type="void" />
|
||
<param index="0" name="value" type="Vector3" />
|
||
<description>
|
||
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.
|
||
</description>
|
||
</method>
|
||
<method name="set_gyroscope">
|
||
<return type="void" />
|
||
<param index="0" name="value" type="Vector3" />
|
||
<description>
|
||
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.
|
||
</description>
|
||
</method>
|
||
<method name="set_magnetometer">
|
||
<return type="void" />
|
||
<param index="0" name="value" type="Vector3" />
|
||
<description>
|
||
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.
|
||
</description>
|
||
</method>
|
||
<method name="should_ignore_device" qualifiers="const">
|
||
<return type="bool" />
|
||
<param index="0" name="vendor_id" type="int" />
|
||
<param index="1" name="product_id" type="int" />
|
||
<description>
|
||
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.
|
||
</description>
|
||
</method>
|
||
<method name="start_joy_vibration">
|
||
<return type="void" />
|
||
<param index="0" name="device" type="int" />
|
||
<param index="1" name="weak_magnitude" type="float" />
|
||
<param index="2" name="strong_magnitude" type="float" />
|
||
<param index="3" name="duration" type="float" default="0" />
|
||
<description>
|
||
Starts to vibrate the joypad. Joypads usually come with two rumble motors, a strong and a weak one. [param weak_magnitude] is the strength of the weak motor (between 0 and 1) and [param strong_magnitude] is the strength of the strong motor (between 0 and 1). [param duration] is the duration of the effect in seconds (a duration of 0 will try to play the vibration indefinitely). The vibration can be stopped early by calling [method stop_joy_vibration].
|
||
[b]Note:[/b] Not every hardware is compatible with long effect durations; it is recommended to restart an effect if it has to be played for more than a few seconds.
|
||
[b]Note:[/b] For macOS, vibration is only supported in macOS 11 and later.
|
||
</description>
|
||
</method>
|
||
<method name="stop_joy_vibration">
|
||
<return type="void" />
|
||
<param index="0" name="device" type="int" />
|
||
<description>
|
||
Stops the vibration of the joypad started with [method start_joy_vibration].
|
||
</description>
|
||
</method>
|
||
<method name="vibrate_handheld">
|
||
<return type="void" />
|
||
<param index="0" name="duration_ms" type="int" default="500" />
|
||
<description>
|
||
Vibrate the handheld device for the specified duration in milliseconds.
|
||
[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] Some web browsers such as Safari and Firefox for Android do not support [method vibrate_handheld].
|
||
</description>
|
||
</method>
|
||
<method name="warp_mouse">
|
||
<return type="void" />
|
||
<param index="0" name="position" type="Vector2" />
|
||
<description>
|
||
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.
|
||
</description>
|
||
</method>
|
||
</methods>
|
||
<members>
|
||
<member name="emulate_mouse_from_touch" type="bool" setter="set_emulate_mouse_from_touch" getter="is_emulating_mouse_from_touch">
|
||
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].
|
||
</member>
|
||
<member name="emulate_touch_from_mouse" type="bool" setter="set_emulate_touch_from_mouse" getter="is_emulating_touch_from_mouse">
|
||
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].
|
||
</member>
|
||
<member name="mouse_mode" type="int" setter="set_mouse_mode" getter="get_mouse_mode" enum="Input.MouseMode">
|
||
Controls the mouse mode. See [enum MouseMode] for more information.
|
||
</member>
|
||
<member name="use_accumulated_input" type="bool" setter="set_use_accumulated_input" getter="is_using_accumulated_input">
|
||
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.
|
||
</member>
|
||
</members>
|
||
<signals>
|
||
<signal name="joy_connection_changed">
|
||
<param index="0" name="device" type="int" />
|
||
<param index="1" name="connected" type="bool" />
|
||
<description>
|
||
Emitted when a joypad device has been connected or disconnected.
|
||
</description>
|
||
</signal>
|
||
</signals>
|
||
<constants>
|
||
<constant name="MOUSE_MODE_VISIBLE" value="0" enum="MouseMode">
|
||
Makes the mouse cursor visible if it is hidden.
|
||
</constant>
|
||
<constant name="MOUSE_MODE_HIDDEN" value="1" enum="MouseMode">
|
||
Makes the mouse cursor hidden if it is visible.
|
||
</constant>
|
||
<constant name="MOUSE_MODE_CAPTURED" value="2" enum="MouseMode">
|
||
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].
|
||
</constant>
|
||
<constant name="MOUSE_MODE_CONFINED" value="3" enum="MouseMode">
|
||
Confines the mouse cursor to the game window, and make it visible.
|
||
</constant>
|
||
<constant name="MOUSE_MODE_CONFINED_HIDDEN" value="4" enum="MouseMode">
|
||
Confines the mouse cursor to the game window, and make it hidden.
|
||
</constant>
|
||
<constant name="CURSOR_ARROW" value="0" enum="CursorShape">
|
||
Arrow cursor. Standard, default pointing cursor.
|
||
</constant>
|
||
<constant name="CURSOR_IBEAM" value="1" enum="CursorShape">
|
||
I-beam cursor. Usually used to show where the text cursor will appear when the mouse is clicked.
|
||
</constant>
|
||
<constant name="CURSOR_POINTING_HAND" value="2" enum="CursorShape">
|
||
Pointing hand cursor. Usually used to indicate the pointer is over a link or other interactable item.
|
||
</constant>
|
||
<constant name="CURSOR_CROSS" value="3" enum="CursorShape">
|
||
Cross cursor. Typically appears over regions in which a drawing operation can be performed or for selections.
|
||
</constant>
|
||
<constant name="CURSOR_WAIT" value="4" enum="CursorShape">
|
||
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).
|
||
</constant>
|
||
<constant name="CURSOR_BUSY" value="5" enum="CursorShape">
|
||
Busy cursor. Indicates that the application is busy performing an operation, and that it is still usable during the operation.
|
||
</constant>
|
||
<constant name="CURSOR_DRAG" value="6" enum="CursorShape">
|
||
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.
|
||
</constant>
|
||
<constant name="CURSOR_CAN_DROP" value="7" enum="CursorShape">
|
||
Can drop cursor. Usually displayed when dragging something to indicate that it can be dropped at the current position.
|
||
</constant>
|
||
<constant name="CURSOR_FORBIDDEN" value="8" enum="CursorShape">
|
||
Forbidden cursor. Indicates that the current action is forbidden (for example, when dragging something) or that the control at a position is disabled.
|
||
</constant>
|
||
<constant name="CURSOR_VSIZE" value="9" enum="CursorShape">
|
||
Vertical resize mouse cursor. A double-headed vertical arrow. It tells the user they can resize the window or the panel vertically.
|
||
</constant>
|
||
<constant name="CURSOR_HSIZE" value="10" enum="CursorShape">
|
||
Horizontal resize mouse cursor. A double-headed horizontal arrow. It tells the user they can resize the window or the panel horizontally.
|
||
</constant>
|
||
<constant name="CURSOR_BDIAGSIZE" value="11" enum="CursorShape">
|
||
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.
|
||
</constant>
|
||
<constant name="CURSOR_FDIAGSIZE" value="12" enum="CursorShape">
|
||
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.
|
||
</constant>
|
||
<constant name="CURSOR_MOVE" value="13" enum="CursorShape">
|
||
Move cursor. Indicates that something can be moved.
|
||
</constant>
|
||
<constant name="CURSOR_VSPLIT" value="14" enum="CursorShape">
|
||
Vertical split mouse cursor. On Windows, it's the same as [constant CURSOR_VSIZE].
|
||
</constant>
|
||
<constant name="CURSOR_HSPLIT" value="15" enum="CursorShape">
|
||
Horizontal split mouse cursor. On Windows, it's the same as [constant CURSOR_HSIZE].
|
||
</constant>
|
||
<constant name="CURSOR_HELP" value="16" enum="CursorShape">
|
||
Help cursor. Usually a question mark.
|
||
</constant>
|
||
</constants>
|
||
</class>
|