Skip to content

Commit 5bbe7cc

Browse files
authored
Merge pull request #11121 from godotengine/classref/sync-71a9948
classref: Sync with current master branch (71a9948)
2 parents ff29de0 + 7a231ea commit 5bbe7cc

9 files changed

+264
-28
lines changed

classes/class_animationmixer.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,8 @@ Notifies when an animation list is changed.
169169

170170
Notifies when an animation starts playing.
171171

172+
\ **Note:** This signal is not emitted if an animation is looping.
173+
172174
.. rst-class:: classref-item-separator
173175

174176
----

classes/class_displayserver.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2128,7 +2128,9 @@ The window background can be transparent.
21282128

21292129
\ **Note:** This flag has no effect if :ref:`is_window_transparency_available()<class_DisplayServer_method_is_window_transparency_available>` returns ``false``.
21302130

2131-
\ **Note:** Transparency support is implemented on Android, Linux (X11/Wayland), macOS, and Windows, but availability might vary depending on GPU driver, display manager, and compositor capabilities.
2131+
\ **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.
2132+
2133+
\ **Note:** Transparency support is implemented on Android, but can only be enabled via :ref:`ProjectSettings.display/window/per_pixel_transparency/allowed<class_ProjectSettings_property_display/window/per_pixel_transparency/allowed>`. This flag has no effect on Android.
21322134

21332135
.. _class_DisplayServer_constant_WINDOW_FLAG_NO_FOCUS:
21342136

@@ -5987,6 +5989,8 @@ Unregisters an :ref:`Object<class_Object>` representing an additional output, th
59875989

59885990
Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or if it is currently hidden.
59895991

5992+
\ **Note:** On Android 7 and 8, the keyboard height may return 0 the first time the keyboard is opened in non-immersive mode. This behavior does not occur in immersive mode.
5993+
59905994
.. rst-class:: classref-item-separator
59915995

59925996
----

classes/class_editorsettings.rst

Lines changed: 180 additions & 2 deletions
Large diffs are not rendered by default.

classes/class_projectsettings.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4794,6 +4794,8 @@ If ``true``, enables a window manager hint that the main window background *can*
47944794

47954795
\ **Note:** This setting has no effect if :ref:`display/window/per_pixel_transparency/allowed<class_ProjectSettings_property_display/window/per_pixel_transparency/allowed>` is set to ``false``.
47964796

4797+
\ **Note:** This setting has no effect on Android as transparency is controlled only via :ref:`display/window/per_pixel_transparency/allowed<class_ProjectSettings_property_display/window/per_pixel_transparency/allowed>`.
4798+
47974799
.. rst-class:: classref-item-separator
47984800

47994801
----
@@ -11174,7 +11176,7 @@ Sets the sensitivity to edges when using SMAA for antialiasing. Lower values wil
1117411176

1117511177
:ref:`bool<class_bool>` **rendering/anti_aliasing/quality/use_debanding** = ``false`` :ref:`🔗<class_ProjectSettings_property_rendering/anti_aliasing/quality/use_debanding>`
1117611178

11177-
If ``true``, uses a fast post-processing filter to make banding significantly less visible in 3D. 2D rendering is *not* affected by debanding unless the :ref:`Environment.background_mode<class_Environment_property_background_mode>` is :ref:`Environment.BG_CANVAS<class_Environment_constant_BG_CANVAS>`.
11179+
If ``true``, uses a fast post-processing filter to make banding significantly less visible. If :ref:`rendering/viewport/hdr_2d<class_ProjectSettings_property_rendering/viewport/hdr_2d>` is ``false``, 2D rendering is *not* affected by debanding unless the :ref:`Environment.background_mode<class_Environment_property_background_mode>` is :ref:`Environment.BG_CANVAS<class_Environment_constant_BG_CANVAS>`. If :ref:`rendering/viewport/hdr_2d<class_ProjectSettings_property_rendering/viewport/hdr_2d>` is ``true``, debanding will affect all 2D and 3D rendering, including canvas items.
1117811180

1117911181
In some cases, debanding may introduce a slightly noticeable dithering pattern. It's recommended to enable debanding only when actually needed since the dithering pattern will make lossless-compressed screenshots larger.
1118011182

classes/class_renderingserver.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12475,7 +12475,7 @@ Sets when the viewport should be updated.
1247512475

1247612476
|void| **viewport_set_use_debanding**\ (\ viewport\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_use_debanding>`
1247712477

12478-
If ``true``, enables debanding on the specified viewport. Equivalent to :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_debanding<class_ProjectSettings_property_rendering/anti_aliasing/quality/use_debanding>` or :ref:`Viewport.use_debanding<class_Viewport_property_use_debanding>`.
12478+
Equivalent to :ref:`Viewport.use_debanding<class_Viewport_property_use_debanding>`. See also :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_debanding<class_ProjectSettings_property_rendering/anti_aliasing/quality/use_debanding>`.
1247912479

1248012480
.. rst-class:: classref-item-separator
1248112481

classes/class_spinbox.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,9 @@ Changes the alignment of the underlying :ref:`LineEdit<class_LineEdit>`.
208208
- |void| **set_custom_arrow_step**\ (\ value\: :ref:`float<class_float>`\ )
209209
- :ref:`float<class_float>` **get_custom_arrow_step**\ (\ )
210210

211-
If not ``0``, :ref:`Range.value<class_Range_property_value>` will always be rounded to a multiple of :ref:`custom_arrow_step<class_SpinBox_property_custom_arrow_step>` when interacting with the arrow buttons of the **SpinBox**.
211+
If not ``0``, sets the step when interacting with the arrow buttons of the **SpinBox**.
212+
213+
\ **Note:** :ref:`Range.value<class_Range_property_value>` will still be rounded to a multiple of :ref:`step<class_SpinBox_property_step>`.
212214

213215
.. rst-class:: classref-item-separator
214216

classes/class_splitcontainer.rst

Lines changed: 63 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -82,27 +82,33 @@ Theme Properties
8282
.. table::
8383
:widths: auto
8484

85-
+-----------------------------------+-------------------------------------------------------------------------------------------+--------+
86-
| :ref:`int<class_int>` | :ref:`autohide<class_SplitContainer_theme_constant_autohide>` | ``1`` |
87-
+-----------------------------------+-------------------------------------------------------------------------------------------+--------+
88-
| :ref:`int<class_int>` | :ref:`minimum_grab_thickness<class_SplitContainer_theme_constant_minimum_grab_thickness>` | ``6`` |
89-
+-----------------------------------+-------------------------------------------------------------------------------------------+--------+
90-
| :ref:`int<class_int>` | :ref:`separation<class_SplitContainer_theme_constant_separation>` | ``12`` |
91-
+-----------------------------------+-------------------------------------------------------------------------------------------+--------+
92-
| :ref:`Texture2D<class_Texture2D>` | :ref:`grabber<class_SplitContainer_theme_icon_grabber>` | |
93-
+-----------------------------------+-------------------------------------------------------------------------------------------+--------+
94-
| :ref:`Texture2D<class_Texture2D>` | :ref:`h_grabber<class_SplitContainer_theme_icon_h_grabber>` | |
95-
+-----------------------------------+-------------------------------------------------------------------------------------------+--------+
96-
| :ref:`Texture2D<class_Texture2D>` | :ref:`h_touch_dragger<class_SplitContainer_theme_icon_h_touch_dragger>` | |
97-
+-----------------------------------+-------------------------------------------------------------------------------------------+--------+
98-
| :ref:`Texture2D<class_Texture2D>` | :ref:`touch_dragger<class_SplitContainer_theme_icon_touch_dragger>` | |
99-
+-----------------------------------+-------------------------------------------------------------------------------------------+--------+
100-
| :ref:`Texture2D<class_Texture2D>` | :ref:`v_grabber<class_SplitContainer_theme_icon_v_grabber>` | |
101-
+-----------------------------------+-------------------------------------------------------------------------------------------+--------+
102-
| :ref:`Texture2D<class_Texture2D>` | :ref:`v_touch_dragger<class_SplitContainer_theme_icon_v_touch_dragger>` | |
103-
+-----------------------------------+-------------------------------------------------------------------------------------------+--------+
104-
| :ref:`StyleBox<class_StyleBox>` | :ref:`split_bar_background<class_SplitContainer_theme_style_split_bar_background>` | |
105-
+-----------------------------------+-------------------------------------------------------------------------------------------+--------+
85+
+-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+
86+
| :ref:`Color<class_Color>` | :ref:`touch_dragger_color<class_SplitContainer_theme_color_touch_dragger_color>` | ``Color(1, 1, 1, 0.3)`` |
87+
+-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+
88+
| :ref:`Color<class_Color>` | :ref:`touch_dragger_hover_color<class_SplitContainer_theme_color_touch_dragger_hover_color>` | ``Color(1, 1, 1, 0.6)`` |
89+
+-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+
90+
| :ref:`Color<class_Color>` | :ref:`touch_dragger_pressed_color<class_SplitContainer_theme_color_touch_dragger_pressed_color>` | ``Color(1, 1, 1, 1)`` |
91+
+-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+
92+
| :ref:`int<class_int>` | :ref:`autohide<class_SplitContainer_theme_constant_autohide>` | ``1`` |
93+
+-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+
94+
| :ref:`int<class_int>` | :ref:`minimum_grab_thickness<class_SplitContainer_theme_constant_minimum_grab_thickness>` | ``6`` |
95+
+-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+
96+
| :ref:`int<class_int>` | :ref:`separation<class_SplitContainer_theme_constant_separation>` | ``12`` |
97+
+-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+
98+
| :ref:`Texture2D<class_Texture2D>` | :ref:`grabber<class_SplitContainer_theme_icon_grabber>` | |
99+
+-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+
100+
| :ref:`Texture2D<class_Texture2D>` | :ref:`h_grabber<class_SplitContainer_theme_icon_h_grabber>` | |
101+
+-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+
102+
| :ref:`Texture2D<class_Texture2D>` | :ref:`h_touch_dragger<class_SplitContainer_theme_icon_h_touch_dragger>` | |
103+
+-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+
104+
| :ref:`Texture2D<class_Texture2D>` | :ref:`touch_dragger<class_SplitContainer_theme_icon_touch_dragger>` | |
105+
+-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+
106+
| :ref:`Texture2D<class_Texture2D>` | :ref:`v_grabber<class_SplitContainer_theme_icon_v_grabber>` | |
107+
+-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+
108+
| :ref:`Texture2D<class_Texture2D>` | :ref:`v_touch_dragger<class_SplitContainer_theme_icon_v_touch_dragger>` | |
109+
+-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+
110+
| :ref:`StyleBox<class_StyleBox>` | :ref:`split_bar_background<class_SplitContainer_theme_style_split_bar_background>` | |
111+
+-----------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+
106112

107113
.. rst-class:: classref-section-separator
108114

@@ -413,6 +419,42 @@ Returns the drag area :ref:`Control<class_Control>`. For example, you can move a
413419
Theme Property Descriptions
414420
---------------------------
415421

422+
.. _class_SplitContainer_theme_color_touch_dragger_color:
423+
424+
.. rst-class:: classref-themeproperty
425+
426+
:ref:`Color<class_Color>` **touch_dragger_color** = ``Color(1, 1, 1, 0.3)`` :ref:`🔗<class_SplitContainer_theme_color_touch_dragger_color>`
427+
428+
The color of the touch dragger.
429+
430+
.. rst-class:: classref-item-separator
431+
432+
----
433+
434+
.. _class_SplitContainer_theme_color_touch_dragger_hover_color:
435+
436+
.. rst-class:: classref-themeproperty
437+
438+
:ref:`Color<class_Color>` **touch_dragger_hover_color** = ``Color(1, 1, 1, 0.6)`` :ref:`🔗<class_SplitContainer_theme_color_touch_dragger_hover_color>`
439+
440+
The color of the touch dragger when hovered.
441+
442+
.. rst-class:: classref-item-separator
443+
444+
----
445+
446+
.. _class_SplitContainer_theme_color_touch_dragger_pressed_color:
447+
448+
.. rst-class:: classref-themeproperty
449+
450+
:ref:`Color<class_Color>` **touch_dragger_pressed_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗<class_SplitContainer_theme_color_touch_dragger_pressed_color>`
451+
452+
The color of the touch dragger when pressed.
453+
454+
.. rst-class:: classref-item-separator
455+
456+
----
457+
416458
.. _class_SplitContainer_theme_constant_autohide:
417459

418460
.. rst-class:: classref-themeproperty

classes/class_translation.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ Tutorials
3030

3131
- :doc:`Internationalizing games <../tutorials/i18n/internationalizing_games>`
3232

33+
- :doc:`Localization using gettext <../tutorials/i18n/localization_using_gettext>`
34+
3335
- :doc:`Locales <../tutorials/i18n/locales>`
3436

3537
.. rst-class:: classref-reftable-group
@@ -153,6 +155,8 @@ Adds a message involving plural translation if nonexistent, followed by its tran
153155

154156
An additional context could be used to specify the translation context or differentiate polysemic words.
155157

158+
\ **Note:** Plurals are only supported in :doc:`gettext-based translations (PO) <../tutorials/i18n/localization_using_gettext>`, not CSV.
159+
156160
.. rst-class:: classref-item-separator
157161

158162
----
@@ -215,6 +219,8 @@ Returns a message's translation involving plurals.
215219

216220
The number ``n`` is the number or quantity of the plural object. It will be used to guide the translation system to fetch the correct plural form for the selected language.
217221

222+
\ **Note:** Plurals are only supported in :doc:`gettext-based translations (PO) <../tutorials/i18n/localization_using_gettext>`, not CSV.
223+
218224
.. rst-class:: classref-item-separator
219225

220226
----

classes/class_viewport.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1945,7 +1945,7 @@ If ``true``, the viewport should render its background as transparent.
19451945
- |void| **set_use_debanding**\ (\ value\: :ref:`bool<class_bool>`\ )
19461946
- :ref:`bool<class_bool>` **is_using_debanding**\ (\ )
19471947

1948-
If ``true``, uses a fast post-processing filter to make banding significantly less visible in 3D. 2D rendering is *not* affected by debanding unless the :ref:`Environment.background_mode<class_Environment_property_background_mode>` is :ref:`Environment.BG_CANVAS<class_Environment_constant_BG_CANVAS>`.
1948+
If ``true``, uses a fast post-processing filter to make banding significantly less visible. If :ref:`use_hdr_2d<class_Viewport_property_use_hdr_2d>` is ``false``, 2D rendering is *not* affected by debanding unless the :ref:`Environment.background_mode<class_Environment_property_background_mode>` is :ref:`Environment.BG_CANVAS<class_Environment_constant_BG_CANVAS>`. If :ref:`use_hdr_2d<class_Viewport_property_use_hdr_2d>` is ``true``, debanding will only be applied if this is the root **Viewport** and will affect all 2D and 3D rendering, including canvas items.
19491949

19501950
In some cases, debanding may introduce a slightly noticeable dithering pattern. It's recommended to enable debanding only when actually needed since the dithering pattern will make lossless-compressed screenshots larger.
19511951

0 commit comments

Comments
 (0)