Skip to content

Commit f95c1a2

Browse files
author
Godot Organization
committed
classref: Sync with current master branch (b7feebe)
1 parent 65ad2cf commit f95c1a2

17 files changed

+81
-119
lines changed

‎classes/[email protected]‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,12 +213,14 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_COLOR_NO_ALPHA<class_@GlobalScope_cons
213213

214214
**@export_custom**\ (\ hint\: :ref:`PropertyHint<enum_@GlobalScope_PropertyHint>`, hint_string\: :ref:`String<class_String>`, usage\: |bitfield|\[:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>`\] = 6\ )
215215

216-
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.
216+
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.
217217

218218
::
219219

220220
@export_custom(PROPERTY_HINT_NONE, "suffix:m") var suffix: Vector3
221221

222+
\ **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.
223+
222224
.. rst-class:: classref-item-separator
223225

224226
----

‎classes/[email protected]‎

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,6 @@ Properties
6363
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
6464
| :ref:`Geometry3D<class_Geometry3D>` | :ref:`Geometry3D<class_@GlobalScope_property_Geometry3D>` |
6565
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
66-
| :ref:`GodotSharp<class_GodotSharp>` | :ref:`GodotSharp<class_@GlobalScope_property_GodotSharp>` |
67-
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
6866
| :ref:`IP<class_IP>` | :ref:`IP<class_@GlobalScope_property_IP>` |
6967
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
7068
| :ref:`Input<class_Input>` | :ref:`Input<class_@GlobalScope_property_Input>` |
@@ -4879,18 +4877,6 @@ The :ref:`Geometry3D<class_Geometry3D>` singleton.
48794877

48804878
----
48814879

4882-
.. _class_@GlobalScope_property_GodotSharp:
4883-
4884-
.. rst-class:: classref-property
4885-
4886-
:ref:`GodotSharp<class_GodotSharp>` **GodotSharp**
4887-
4888-
The :ref:`GodotSharp<class_GodotSharp>` singleton.
4889-
4890-
.. rst-class:: classref-item-separator
4891-
4892-
----
4893-
48944880
.. _class_@GlobalScope_property_IP:
48954881

48964882
.. rst-class:: classref-property

‎classes/class_button.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -567,7 +567,7 @@ The horizontal space between **Button**'s icon and text. Negative values will be
567567

568568
:ref:`int<class_int>` **icon_max_width** = ``0``
569569

570-
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.
570+
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.
571571

572572
.. rst-class:: classref-item-separator
573573

‎classes/class_confirmationdialog.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ To get cancel action, you can use:
3030

3131
.. code-tab:: gdscript
3232

33-
get_cancel_button().pressed.connect(self.canceled)
33+
get_cancel_button().pressed.connect(_on_canceled)
3434

3535
.. code-tab:: csharp
3636

37-
GetCancelButton().Pressed += Canceled;
37+
GetCancelButton().Pressed += OnCanceled;
3838

3939

4040

‎classes/class_csharpscript.rst‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,6 @@ Description
2121

2222
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.
2323

24-
See also :ref:`GodotSharp<class_GodotSharp>`.
25-
2624
.. rst-class:: classref-introduction-group
2725

2826
Tutorials

‎classes/class_displayserver.rst‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,8 @@ Methods
204204
+-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
205205
| :ref:`bool<class_bool>` | :ref:`is_touchscreen_available<class_DisplayServer_method_is_touchscreen_available>`\ (\ ) |const| |
206206
+-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
207+
| :ref:`bool<class_bool>` | :ref:`is_window_transparency_available<class_DisplayServer_method_is_window_transparency_available>`\ (\ ) |const| |
208+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
207209
| :ref:`int<class_int>` | :ref:`keyboard_get_current_layout<class_DisplayServer_method_keyboard_get_current_layout>`\ (\ ) |const| |
208210
+-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
209211
| :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
11181120

11191121
The window background can be transparent.
11201122

1121-
\ **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``.
1123+
\ **Note:** This flag has no effect if :ref:`is_window_transparency_available<class_DisplayServer_method_is_window_transparency_available>` returns ``false``.
11221124

11231125
\ **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.
11241126

@@ -2969,6 +2971,18 @@ Returns ``true`` if touch events are available (Android or iOS), the capability
29692971

29702972
----
29712973

2974+
.. _class_DisplayServer_method_is_window_transparency_available:
2975+
2976+
.. rst-class:: classref-method
2977+
2978+
:ref:`bool<class_bool>` **is_window_transparency_available**\ (\ ) |const|
2979+
2980+
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.
2981+
2982+
.. rst-class:: classref-item-separator
2983+
2984+
----
2985+
29722986
.. _class_DisplayServer_method_keyboard_get_current_layout:
29732987

29742988
.. rst-class:: classref-method

‎classes/class_editorinspector.rst‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,6 @@ Properties
3939
.. table::
4040
:widths: auto
4141

42-
+----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+
43-
| :ref:`bool<class_bool>` | follow_focus | ``true`` (overrides :ref:`ScrollContainer<class_ScrollContainer_property_follow_focus>`) |
4442
+----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+
4543
| :ref:`ScrollMode<enum_ScrollContainer_ScrollMode>` | horizontal_scroll_mode | ``0`` (overrides :ref:`ScrollContainer<class_ScrollContainer_property_horizontal_scroll_mode>`) |
4644
+----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+

‎classes/class_editorinspectorplugin.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,8 @@ Adds a custom control, which is not necessarily a property editor.
169169

170170
Adds a property editor for an individual property. The ``editor`` control must extend :ref:`EditorProperty<class_EditorProperty>`.
171171

172+
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.
173+
172174
.. rst-class:: classref-item-separator
173175

174176
----

‎classes/class_geometry2d.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -375,6 +375,8 @@ Returns ``true`` if ``point`` is inside ``polygon`` or if it's located exactly *
375375

376376
Returns ``true`` if ``polygon``'s vertices are ordered in clockwise order, otherwise returns ``false``.
377377

378+
\ **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).
379+
378380
.. rst-class:: classref-item-separator
379381

380382
----

‎classes/class_gltfdocument.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -248,6 +248,8 @@ Takes a :ref:`GLTFState<class_GLTFState>` object through the ``state`` parameter
248248

249249
Takes a :ref:`GLTFState<class_GLTFState>` object through the ``state`` parameter and returns a Godot Engine scene node.
250250

251+
The ``bake_fps`` parameter overrides the bake_fps in ``state``.
252+
251253
.. rst-class:: classref-item-separator
252254

253255
----

0 commit comments

Comments
 (0)