Merge pull request #8939 from godotengine/classref/sync-4e990cd

classref: Sync with current master branch (4e990cd)
godotengine · Feb 10, 2024 · 4ead5aa · 4ead5aa
2 parents 5062d09 + 7939a16
commit 4ead5aa
Show file tree

Hide file tree

Showing 32 changed files with 978 additions and 399 deletions.
diff --git a/classes/class_callable.rst b/classes/class_callable.rst
@@ -242,11 +242,23 @@ void **call_deferred** **(** ... **)** |vararg| |const|
 
 Calls the method represented by this **Callable** in deferred mode, i.e. at the end of the current frame. Arguments can be passed and should match the method's signature.
 
-::
+
+.. tabs::
+
+ .. code-tab:: gdscript
 
     func _ready():
         grab_focus.call_deferred()
 
+ .. code-tab:: csharp
+
+    public override void _Ready()
+    {
+        Callable.From(GrabFocus).CallDeferred();
+    }
+
+
+
 See also :ref:`Object.call_deferred<class_Object_method_call_deferred>`.
 
 .. rst-class:: classref-item-separator

diff --git a/classes/class_color.rst b/classes/class_color.rst
@@ -17,7 +17,7 @@ A color represented in RGBA format.
 Description
 -----------
 
-A color represented in RGBA format by a red (:ref:`r<class_Color_property_r>`), green (:ref:`g<class_Color_property_g>`), blue (:ref:`b<class_Color_property_b>`), and alpha (:ref:`a<class_Color_property_a>`) component. Each component is a 16-bit floating-point value, usually ranging from ``0.0`` to ``1.0``. Some properties (such as :ref:`CanvasItem.modulate<class_CanvasItem_property_modulate>`) may support values greater than ``1.0``, for overbright or HDR (High Dynamic Range) colors.
+A color represented in RGBA format by a red (:ref:`r<class_Color_property_r>`), green (:ref:`g<class_Color_property_g>`), blue (:ref:`b<class_Color_property_b>`), and alpha (:ref:`a<class_Color_property_a>`) component. Each component is a 32-bit floating-point value, usually ranging from ``0.0`` to ``1.0``. Some properties (such as :ref:`CanvasItem.modulate<class_CanvasItem_property_modulate>`) may support values greater than ``1.0``, for overbright or HDR (High Dynamic Range) colors.
 
 Colors can be created in various ways: By the various **Color** constructors, by static methods such as :ref:`from_hsv<class_Color_method_from_hsv>`, and by using a name from the set of standardized colors based on `X11 color names <https://en.wikipedia.org/wiki/X11_color_names>`__ with the addition of :ref:`TRANSPARENT<class_Color_constant_TRANSPARENT>`. GDScript also provides :ref:`@GDScript.Color8<class_@GDScript_method_Color8>`, which uses integers from ``0`` to ``255`` and doesn't support overbright colors.
 

diff --git a/classes/class_displayserver.rst b/classes/class_displayserver.rst
@@ -466,7 +466,7 @@ Display server supports setting the mouse cursor shape to a custom image. **Wind
 
 :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG** = ``9``
 
-Display server supports spawning dialogs using the operating system's native look-and-feel. **macOS**
+Display server supports spawning dialogs using the operating system's native look-and-feel. **Windows, macOS, Linux (X11/Wayland)**
 
 .. _class_DisplayServer_constant_FEATURE_IME:
 

diff --git a/classes/class_editorexportplatform.rst b/classes/class_editorexportplatform.rst
@@ -30,7 +30,7 @@ Used in scripting by :ref:`EditorExportPlugin<class_EditorExportPlugin>` to conf
 Tutorials
 ---------
 
-- `$DOCS_URL/tutorials/platform/consoles.html <Console support in Godot>`__
+- :doc:`Console support in Godot <../tutorials/platform/consoles>`
 
 .. rst-class:: classref-reftable-group
 

diff --git a/classes/class_editorexportplatformandroid.rst b/classes/class_editorexportplatformandroid.rst
@@ -834,7 +834,13 @@ If ``true``, package signing is enabled.
 
 :ref:`String<class_String>` **package/unique_name**
 
-Unique application identifier in a reverse-DNS format, can only contain alphanumeric characters (``A-Z``, ``a-z``, and ``0-9``), hyphens (``-``), and periods (``.``).
+Unique application identifier in a reverse-DNS format. The reverse DNS format should preferably match a domain name you control, but this is not strictly required. For instance, if you own ``example.com``, your package unique name should preferably be of the form ``com.example.mygame``. This identifier can only contain lowercase alphanumeric characters (``a-z``, and ``0-9``), underscores (``_``), and periods (``.``). Each component of the reverse DNS format must start with a letter: for instance, ``com.example.8game`` is not valid.
+
+If ``$genname`` is present in the value, it will be replaced by the project name converted to lowercase. If there are invalid characters in the project name, they will be stripped. If all characters in the project name are stripped, ``$genname`` is replaced by ``noname``.
+
+\ **Note:** Changing the package name will cause the package to be considered as a new package, with its own installation and data paths. The new package won't be usable to update existing installations.
+
+\ **Note:** When publishing to Google Play, the package name must be *globally* unique. This means no other apps published on Google Play must be using the same package name as yours. Otherwise, you'll be prevented from publishing your app on Google Play.
 
 .. rst-class:: classref-item-separator
 

diff --git a/classes/class_editorinterface.rst b/classes/class_editorinterface.rst
diff --git a/classes/class_editorproperty.rst b/classes/class_editorproperty.rst
@@ -29,21 +29,23 @@ Properties
 .. table::
    :widths: auto
 
-   +-----------------------------+-----------------------------------------------------------------+-----------+
-   | :ref:`bool<class_bool>`     | :ref:`checkable<class_EditorProperty_property_checkable>`       | ``false`` |
-   +-----------------------------+-----------------------------------------------------------------+-----------+
-   | :ref:`bool<class_bool>`     | :ref:`checked<class_EditorProperty_property_checked>`           | ``false`` |
-   +-----------------------------+-----------------------------------------------------------------+-----------+
-   | :ref:`bool<class_bool>`     | :ref:`deletable<class_EditorProperty_property_deletable>`       | ``false`` |
-   +-----------------------------+-----------------------------------------------------------------+-----------+
-   | :ref:`bool<class_bool>`     | :ref:`draw_warning<class_EditorProperty_property_draw_warning>` | ``false`` |
-   +-----------------------------+-----------------------------------------------------------------+-----------+
-   | :ref:`bool<class_bool>`     | :ref:`keying<class_EditorProperty_property_keying>`             | ``false`` |
-   +-----------------------------+-----------------------------------------------------------------+-----------+
-   | :ref:`String<class_String>` | :ref:`label<class_EditorProperty_property_label>`               | ``""``    |
-   +-----------------------------+-----------------------------------------------------------------+-----------+
-   | :ref:`bool<class_bool>`     | :ref:`read_only<class_EditorProperty_property_read_only>`       | ``false`` |
-   +-----------------------------+-----------------------------------------------------------------+-----------+
+   +-----------------------------+-----------------------------------------------------------------------------------+-----------+
+   | :ref:`bool<class_bool>`     | :ref:`checkable<class_EditorProperty_property_checkable>`                         | ``false`` |
+   +-----------------------------+-----------------------------------------------------------------------------------+-----------+
+   | :ref:`bool<class_bool>`     | :ref:`checked<class_EditorProperty_property_checked>`                             | ``false`` |
+   +-----------------------------+-----------------------------------------------------------------------------------+-----------+
+   | :ref:`String<class_String>` | :ref:`configuration_warning<class_EditorProperty_property_configuration_warning>` | ``""``    |
+   +-----------------------------+-----------------------------------------------------------------------------------+-----------+
+   | :ref:`bool<class_bool>`     | :ref:`deletable<class_EditorProperty_property_deletable>`                         | ``false`` |
+   +-----------------------------+-----------------------------------------------------------------------------------+-----------+
+   | :ref:`bool<class_bool>`     | :ref:`draw_warning<class_EditorProperty_property_draw_warning>`                   | ``false`` |
+   +-----------------------------+-----------------------------------------------------------------------------------+-----------+
+   | :ref:`bool<class_bool>`     | :ref:`keying<class_EditorProperty_property_keying>`                               | ``false`` |
+   +-----------------------------+-----------------------------------------------------------------------------------+-----------+
+   | :ref:`String<class_String>` | :ref:`label<class_EditorProperty_property_label>`                                 | ``""``    |
+   +-----------------------------+-----------------------------------------------------------------------------------+-----------+
+   | :ref:`bool<class_bool>`     | :ref:`read_only<class_EditorProperty_property_read_only>`                         | ``false`` |
+   +-----------------------------+-----------------------------------------------------------------------------------+-----------+
 
 .. rst-class:: classref-reftable-group
 
@@ -253,6 +255,23 @@ Used by the inspector, set to ``true`` when the property is checked.
 
 ----
 
+.. _class_EditorProperty_property_configuration_warning:
+
+.. rst-class:: classref-property
+
+:ref:`String<class_String>` **configuration_warning** = ``""``
+
+.. rst-class:: classref-property-setget
+
+- void **set_configuration_warning** **(** :ref:`String<class_String>` value **)**
+- :ref:`String<class_String>` **get_configuration_warning** **(** **)**
+
+Used by the inspector, set to show a configuration warning on the property.
+
+.. rst-class:: classref-item-separator
+
+----
+
 .. _class_EditorProperty_property_deletable:
 
 .. rst-class:: classref-property

diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst
@@ -317,6 +317,8 @@ Properties
    +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | :ref:`bool<class_bool>`       | :ref:`interface/editor/use_embedded_menu<class_EditorSettings_property_interface/editor/use_embedded_menu>`                                                                         |
    +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+   | :ref:`int<class_int>`         | :ref:`interface/editor/vsync_mode<class_EditorSettings_property_interface/editor/vsync_mode>`                                                                                       |
+   +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | :ref:`float<class_float>`     | :ref:`interface/inspector/float_drag_speed<class_EditorSettings_property_interface/inspector/float_drag_speed>`                                                                     |
    +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | :ref:`int<class_int>`         | :ref:`interface/inspector/max_array_dictionary_items_per_page<class_EditorSettings_property_interface/inspector/max_array_dictionary_items_per_page>`                               |
@@ -2341,6 +2343,22 @@ Specific to the macOS platform.
 
 ----
 
+.. _class_EditorSettings_property_interface/editor/vsync_mode:
+
+.. rst-class:: classref-property
+
+:ref:`int<class_int>` **interface/editor/vsync_mode**
+
+Sets the V-Sync mode for the editor. Does not affect the project when run from the editor (this is controlled by :ref:`ProjectSettings.display/window/vsync/vsync_mode<class_ProjectSettings_property_display/window/vsync/vsync_mode>`).
+
+Depending on the platform and used renderer, the engine will fall back to **Enabled** if the desired mode is not supported.
+
+\ **Note:** V-Sync modes other than **Enabled** are only supported in the Forward+ and Mobile rendering methods, not Compatibility.
+
+.. rst-class:: classref-item-separator
+
+----
+
 .. _class_EditorSettings_property_interface/inspector/float_drag_speed:
 
 .. rst-class:: classref-property
@@ -3343,7 +3361,7 @@ The number of pixels to scroll with every mouse wheel increment. Higher values m
 
 :ref:`bool<class_bool>` **text_editor/completion/add_type_hints**
 
-If ``true``, adds static typing hints such as ``-> void`` and ``: int`` when using code autocompletion or when creating onready variables by drag and dropping nodes into the script editor while pressing the :kbd:`Ctrl` key.
+If ``true``, adds :doc:`GDScript static typing <../tutorials/scripting/gdscript/static_typing>` hints such as ``-> void`` and ``: int`` when using code autocompletion or when creating onready variables by drag and dropping nodes into the script editor while pressing the :kbd:`Ctrl` key. If ``true``, newly created scripts will also automatically have type hints added to their method parameters and return types.
 
 .. rst-class:: classref-item-separator
 

diff --git a/classes/class_heightmapshape3d.rst b/classes/class_heightmapshape3d.rst
@@ -39,6 +39,20 @@ Properties
    | :ref:`int<class_int>`                               | :ref:`map_width<class_HeightMapShape3D_property_map_width>` | ``2``                              |
    +-----------------------------------------------------+-------------------------------------------------------------+------------------------------------+
 
+.. rst-class:: classref-reftable-group
+
+Methods
+-------
+
+.. table::
+   :widths: auto
+
+   +---------------------------+-----------------------------------------------------------------------------------------+
+   | :ref:`float<class_float>` | :ref:`get_max_height<class_HeightMapShape3D_method_get_max_height>` **(** **)** |const| |
+   +---------------------------+-----------------------------------------------------------------------------------------+
+   | :ref:`float<class_float>` | :ref:`get_min_height<class_HeightMapShape3D_method_get_min_height>` **(** **)** |const| |
+   +---------------------------+-----------------------------------------------------------------------------------------+
+
 .. rst-class:: classref-section-separator
 
 ----
@@ -59,7 +73,7 @@ Property Descriptions
 - void **set_map_data** **(** :ref:`PackedFloat32Array<class_PackedFloat32Array>` value **)**
 - :ref:`PackedFloat32Array<class_PackedFloat32Array>` **get_map_data** **(** **)**
 
-Height map data, pool array must be of :ref:`map_width<class_HeightMapShape3D_property_map_width>` \* :ref:`map_depth<class_HeightMapShape3D_property_map_depth>` size.
+Height map data. The array's size must be equal to :ref:`map_width<class_HeightMapShape3D_property_map_width>` multiplied by :ref:`map_depth<class_HeightMapShape3D_property_map_depth>`.
 
 .. rst-class:: classref-item-separator
 
@@ -95,6 +109,35 @@ Number of vertices in the depth of the height map. Changing this will resize the
 
 Number of vertices in the width of the height map. Changing this will resize the :ref:`map_data<class_HeightMapShape3D_property_map_data>`.
 
+.. rst-class:: classref-section-separator
+
+----
+
+.. rst-class:: classref-descriptions-group
+
+Method Descriptions
+-------------------
+
+.. _class_HeightMapShape3D_method_get_max_height:
+
+.. rst-class:: classref-method
+
+:ref:`float<class_float>` **get_max_height** **(** **)** |const|
+
+Returns the largest height value found in :ref:`map_data<class_HeightMapShape3D_property_map_data>`. Recalculates only when :ref:`map_data<class_HeightMapShape3D_property_map_data>` changes.
+
+.. rst-class:: classref-item-separator
+
+----
+
+.. _class_HeightMapShape3D_method_get_min_height:
+
+.. rst-class:: classref-method
+
+:ref:`float<class_float>` **get_min_height** **(** **)** |const|
+
+Returns the smallest height value found in :ref:`map_data<class_HeightMapShape3D_property_map_data>`. Recalculates only when :ref:`map_data<class_HeightMapShape3D_property_map_data>` changes.
+
 .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
 .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
 .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

diff --git a/classes/class_input.rst b/classes/class_input.rst
@@ -97,6 +97,8 @@ Methods
    +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | :ref:`Vector2<class_Vector2>`                                           | :ref:`get_joy_vibration_strength<class_Input_method_get_joy_vibration_strength>` **(** :ref:`int<class_int>` device **)**                                                                                                                                                                                    |
    +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+   | :ref:`Vector2<class_Vector2>`                                           | :ref:`get_last_mouse_screen_velocity<class_Input_method_get_last_mouse_screen_velocity>` **(** **)**                                                                                                                                                                                                         |
+   +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | :ref:`Vector2<class_Vector2>`                                           | :ref:`get_last_mouse_velocity<class_Input_method_get_last_mouse_velocity>` **(** **)**                                                                                                                                                                                                                       |
    +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | :ref:`Vector3<class_Vector3>`                                           | :ref:`get_magnetometer<class_Input_method_get_magnetometer>` **(** **)** |const|                                                                                                                                                                                                                             |
@@ -710,6 +712,18 @@ Returns the strength of the joypad vibration: x is the strength of the weak moto
 
 ----
 
+.. _class_Input_method_get_last_mouse_screen_velocity:
+
+.. rst-class:: classref-method
+
+:ref:`Vector2<class_Vector2>` **get_last_mouse_screen_velocity** **(** **)**
+
+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.
+
+.. rst-class:: classref-item-separator
+
+----
+
 .. _class_Input_method_get_last_mouse_velocity:
 
 .. rst-class:: classref-method