classref: Sync with current master branch (543750a)

This commit is contained in:
Godot Organization
2023-06-03 03:19:05 +00:00
parent 2de3798d56
commit f9340bddb2
340 changed files with 1505 additions and 1258 deletions
+5 -5
View File
@@ -12,16 +12,16 @@ Input
**Inherits:** :ref:`Object<class_Object>`
A singleton that deals with inputs.
A singleton for handling inputs.
.. rst-class:: classref-introduction-group
Description
-----------
A singleton that deals with inputs. This includes key presses, mouse buttons and movement, joypads, and input actions. Actions and their events can be set in the **Input Map** tab in the **Project > Project Settings**, or with the :ref:`InputMap<class_InputMap>` class.
The **Input** singleton handles key presses, mouse buttons and movement, gamepads, and input actions. Actions and their events can be set in the **Input Map** tab in **Project > Project Settings**, or with the :ref:`InputMap<class_InputMap>` class.
\ **Note:** The methods here reflect the global input state and are not affected by :ref:`Control.accept_event<class_Control_method_accept_event>` or :ref:`Viewport.set_input_as_handled<class_Viewport_method_set_input_as_handled>`, which only deal with the way input is propagated in the :ref:`SceneTree<class_SceneTree>`.
\ **Note:** **Input**'s methods reflect the global input state and are not affected by :ref:`Control.accept_event<class_Control_method_accept_event>` or :ref:`Viewport.set_input_as_handled<class_Viewport_method_set_input_as_handled>`, as those methods only deal with the way input is propagated in the :ref:`SceneTree<class_SceneTree>`.
.. rst-class:: classref-introduction-group
@@ -600,7 +600,7 @@ Returns the current value of the joypad axis at given index (see :ref:`JoyAxis<e
:ref:`String<class_String>` **get_joy_guid** **(** :ref:`int<class_int>` device **)** |const|
Returns a SDL2-compatible device GUID on platforms that use gamepad remapping. Returns ``"Default Gamepad"`` otherwise.
Returns a SDL2-compatible device GUID on platforms that use gamepad remapping, e.g. ``030000004c050000c405000000010000``. Returns ``"Default Gamepad"`` otherwise. Godot uses the `SDL2 game controller database <https://github.com/gabomdq/SDL_GameControllerDB>`__ to determine gamepad names and mappings based on this GUID.
.. rst-class:: classref-item-separator
@@ -612,7 +612,7 @@ Returns a SDL2-compatible device GUID on platforms that use gamepad remapping. R
:ref:`String<class_String>` **get_joy_name** **(** :ref:`int<class_int>` device **)**
Returns the name of the joypad at the specified device index.
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.
.. rst-class:: classref-item-separator