classref: Sync with current master branch (4714e95)

This commit is contained in:
Godot Organization
2023-08-12 03:18:27 +00:00
parent 4e78e11393
commit f593c47588
68 changed files with 1205 additions and 465 deletions
+28
View File
@@ -85,6 +85,8 @@ Methods
+-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_joy_guid<class_Input_method_get_joy_guid>` **(** :ref:`int<class_int>` device **)** |const| |
+-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`get_joy_info<class_Input_method_get_joy_info>` **(** :ref:`int<class_int>` device **)** |const| |
+-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_joy_name<class_Input_method_get_joy_name>` **(** :ref:`int<class_int>` device **)** |
+-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_joy_vibration_duration<class_Input_method_get_joy_vibration_duration>` **(** :ref:`int<class_int>` device **)** |
@@ -608,6 +610,32 @@ Returns a SDL2-compatible device GUID on platforms that use gamepad remapping, e
----
.. _class_Input_method_get_joy_info:
.. rst-class:: classref-method
:ref:`Dictionary<class_Dictionary>` **get_joy_info** **(** :ref:`int<class_int>` device **)** |const|
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:
\ ``xinput_index``: The index of the controller in the XInput system.
On Linux:
\ ``raw_name``: The name of the controller as it came from the OS, before getting renamed by the godot controller database.
\ ``vendor_id``: The USB vendor ID of the device.
\ ``product_id``: The USB product ID of the device.
\ ``steam_input_index``: The Steam Input gamepad index, if the device is not a Steam Input device this key won't be present.
.. rst-class:: classref-item-separator
----
.. _class_Input_method_get_joy_name:
.. rst-class:: classref-method