Merge pull request #9417 from godotengine/classref/sync-b7feebe

classref: Sync with current master branch (b7feebe)

classes/class_@gdscript.rst

@@ -213,12 +213,14 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_COLOR_NO_ALPHA<class_@GlobalScope_cons
 
 **@export_custom**\ (\ hint\: :ref:`PropertyHint<enum_@GlobalScope_PropertyHint>`, hint_string\: :ref:`String<class_String>`, usage\: |bitfield|\[:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>`\] = 6\ )
 
-Allows you to set a custom hint, hint string, and usage flags for the exported property. Note that there's no validation done in GDScript, it will just pass the hint along to the editor.
+Allows you to set a custom hint, hint string, and usage flags for the exported property. Note that there's no validation done in GDScript, it will just pass the parameters to the editor.
 
 ::
 
     @export_custom(PROPERTY_HINT_NONE, "suffix:m") var suffix: Vector3
 
+\ **Note:** Regardless of the ``usage`` value, the :ref:`@GlobalScope.PROPERTY_USAGE_SCRIPT_VARIABLE<class_@GlobalScope_constant_PROPERTY_USAGE_SCRIPT_VARIABLE>` flag is always added, as with any explicitly declared script variable.
+
 .. rst-class:: classref-item-separator
 
 ----

classes/class_@globalscope.rst

@@ -63,8 +63,6 @@ Properties
    +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
    | :ref:`Geometry3D<class_Geometry3D>`                           | :ref:`Geometry3D<class_@GlobalScope_property_Geometry3D>`                           |
    +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
-   | :ref:`GodotSharp<class_GodotSharp>`                           | :ref:`GodotSharp<class_@GlobalScope_property_GodotSharp>`                           |
-   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
    | :ref:`IP<class_IP>`                                           | :ref:`IP<class_@GlobalScope_property_IP>`                                           |
    +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
    | :ref:`Input<class_Input>`                                     | :ref:`Input<class_@GlobalScope_property_Input>`                                     |
@@ -4879,18 +4877,6 @@ The :ref:`Geometry3D<class_Geometry3D>` singleton.
 
 ----
 
-.. _class_@GlobalScope_property_GodotSharp:
-
-.. rst-class:: classref-property
-
-:ref:`GodotSharp<class_GodotSharp>` **GodotSharp**
-
-The :ref:`GodotSharp<class_GodotSharp>` singleton.
-
-.. rst-class:: classref-item-separator
-
-----
-
 .. _class_@GlobalScope_property_IP:
 
 .. rst-class:: classref-property

classes/class_button.rst

@@ -567,7 +567,7 @@ The horizontal space between **Button**'s icon and text. Negative values will be
 
 :ref:`int<class_int>` **icon_max_width** = ``0``
 
-The maximum allowed width of the **Button**'s icon. This limit is applied on top of the default size of the icon, or its expanded size if :ref:`expand_icon<class_Button_property_expand_icon>` is ``true``. The height is adjusted according to the icon's ratio.
+The maximum allowed width of the **Button**'s icon. This limit is applied on top of the default size of the icon, or its expanded size if :ref:`expand_icon<class_Button_property_expand_icon>` is ``true``. The height is adjusted according to the icon's ratio. If the button has additional icons (e.g. :ref:`CheckBox<class_CheckBox>`), they will also be limited.
 
 .. rst-class:: classref-item-separator
 

classes/class_confirmationdialog.rst

@@ -30,11 +30,11 @@ To get cancel action, you can use:
 
  .. code-tab:: gdscript
 
-    get_cancel_button().pressed.connect(self.canceled)
+    get_cancel_button().pressed.connect(_on_canceled)
 
  .. code-tab:: csharp
 
-    GetCancelButton().Pressed += Canceled;
+    GetCancelButton().Pressed += OnCanceled;
 
 
 

classes/class_csharpscript.rst

@@ -21,8 +21,6 @@ Description
 
 This class represents a C# script. It is the C# equivalent of the :ref:`GDScript<class_GDScript>` class and is only available in Mono-enabled Godot builds.
 
-See also :ref:`GodotSharp<class_GodotSharp>`.
-
 .. rst-class:: classref-introduction-group
 
 Tutorials

classes/class_displayserver.rst

@@ -204,6 +204,8 @@ Methods
    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | :ref:`bool<class_bool>`                                                 | :ref:`is_touchscreen_available<class_DisplayServer_method_is_touchscreen_available>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+   | :ref:`bool<class_bool>`                                                 | :ref:`is_window_transparency_available<class_DisplayServer_method_is_window_transparency_available>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+   +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | :ref:`int<class_int>`                                                   | :ref:`keyboard_get_current_layout<class_DisplayServer_method_keyboard_get_current_layout>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | :ref:`Key<enum_@GlobalScope_Key>`                                       | :ref:`keyboard_get_keycode_from_physical<class_DisplayServer_method_keyboard_get_keycode_from_physical>`\ (\ keycode\: :ref:`Key<enum_@GlobalScope_Key>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                 |
@@ -1118,7 +1120,7 @@ The window is floating on top of all other windows. This flag is ignored for ful
 
 The window background can be transparent.
 
-\ **Note:** This flag has no effect if :ref:`ProjectSettings.display/window/per_pixel_transparency/allowed<class_ProjectSettings_property_display/window/per_pixel_transparency/allowed>` is set to ``false``.
+\ **Note:** This flag has no effect if :ref:`is_window_transparency_available<class_DisplayServer_method_is_window_transparency_available>` returns ``false``.
 
 \ **Note:** Transparency support is implemented on Linux (X11/Wayland), macOS, and Windows, but availability might vary depending on GPU driver, display manager, and compositor capabilities.
 
@@ -2969,6 +2971,18 @@ Returns ``true`` if touch events are available (Android or iOS), the capability
 
 ----
 
+.. _class_DisplayServer_method_is_window_transparency_available:
+
+.. rst-class:: classref-method
+
+:ref:`bool<class_bool>` **is_window_transparency_available**\ (\ ) |const|
+
+Returns ``true`` if the window background can be made transparent. This method returns ``false`` if :ref:`ProjectSettings.display/window/per_pixel_transparency/allowed<class_ProjectSettings_property_display/window/per_pixel_transparency/allowed>` is set to ``false``, or if transparency is not supported by the renderer or OS compositor.
+
+.. rst-class:: classref-item-separator
+
+----
+
 .. _class_DisplayServer_method_keyboard_get_current_layout:
 
 .. rst-class:: classref-method

classes/class_editorinspector.rst

@@ -39,8 +39,6 @@ Properties
 .. table::
    :widths: auto
 
-   +----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+
-   | :ref:`bool<class_bool>`                            | follow_focus           | ``true`` (overrides :ref:`ScrollContainer<class_ScrollContainer_property_follow_focus>`)        |
    +----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+
    | :ref:`ScrollMode<enum_ScrollContainer_ScrollMode>` | horizontal_scroll_mode | ``0`` (overrides :ref:`ScrollContainer<class_ScrollContainer_property_horizontal_scroll_mode>`) |
    +----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+

classes/class_editorinspectorplugin.rst

@@ -169,6 +169,8 @@ Adds a custom control, which is not necessarily a property editor.
 
 Adds a property editor for an individual property. The ``editor`` control must extend :ref:`EditorProperty<class_EditorProperty>`.
 
+There can be multiple property editors for a property. If ``add_to_end`` is ``true``, this newly added editor will be displayed after all the other editors of the property whose ``add_to_end`` is ``false``. For example, the editor uses this parameter to add an "Edit Region" button for :ref:`Sprite2D.region_rect<class_Sprite2D_property_region_rect>` below the regular :ref:`Rect2<class_Rect2>` editor.
+
 .. rst-class:: classref-item-separator
 
 ----

classes/class_geometry2d.rst

@@ -375,6 +375,8 @@ Returns ``true`` if ``point`` is inside ``polygon`` or if it's located exactly *
 
 Returns ``true`` if ``polygon``'s vertices are ordered in clockwise order, otherwise returns ``false``.
 
+\ **Note:** Assumes a Cartesian coordinate system where ``+x`` is right and ``+y`` is up. If using screen coordinates (``+y`` is down), the result will need to be flipped (i.e. a ``true`` result will indicate counter-clockwise).
+
 .. rst-class:: classref-item-separator
 
 ----

classes/class_gltfdocument.rst

@@ -248,6 +248,8 @@ Takes a :ref:`GLTFState<class_GLTFState>` object through the ``state`` parameter
 
 Takes a :ref:`GLTFState<class_GLTFState>` object through the ``state`` parameter and returns a Godot Engine scene node.
 
+The ``bake_fps`` parameter overrides the bake_fps in ``state``.
+
 .. rst-class:: classref-item-separator
 
 ----

classes/class_gltfstate.rst

@@ -42,6 +42,8 @@ Properties
 .. table::
    :widths: auto
 
+   +----------------------------------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
+   | :ref:`float<class_float>`                                                  | :ref:`bake_fps<class_GLTFState_property_bake_fps>`                                 | ``30.0``               |
    +----------------------------------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
    | :ref:`String<class_String>`                                                | :ref:`base_path<class_GLTFState_property_base_path>`                               | ``""``                 |
    +----------------------------------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
@@ -210,6 +212,23 @@ Embeds textures compressed losslessly into the generated scene, matching old beh
 Property Descriptions
 ---------------------
 
+.. _class_GLTFState_property_bake_fps:
+
+.. rst-class:: classref-property
+
+:ref:`float<class_float>` **bake_fps** = ``30.0``
+
+.. rst-class:: classref-property-setget
+
+- |void| **set_bake_fps**\ (\ value\: :ref:`float<class_float>`\ )
+- :ref:`float<class_float>` **get_bake_fps**\ (\ )
+
+The baking fps of the animation for either import or export.
+
+.. rst-class:: classref-item-separator
+
+----
+
 .. _class_GLTFState_property_base_path:
 
 .. rst-class:: classref-property