Skip to content

Commit f74a54c

Browse files
skyace65skyace65
authored
Merge pull request #10980 from godotengine/classref/sync-eb72ce2
classref: Sync with current master branch (eb72ce2)
2 parents ff8419a + fc3dbd3 commit f74a54c

29 files changed

+827
-82
lines changed

‎classes/class_@globalscope.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3887,7 +3887,9 @@ Hints that a property will be changed on its own after setting, such as :ref:`Au
38873887

38883888
:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_GROUP_ENABLE** = ``42``
38893889

3890-
Hints that a boolean property will enable the feature associated with the group that it occurs in. Only works within a group or subgroup.
3890+
Hints that a boolean property will enable the feature associated with the group that it occurs in. Only works within a group or subgroup. Use the optional hint string ``"feature"`` when the group only has variables that are meaningful when the feature is enabled.
3891+
3892+
\ **Note:** The ``"feature"`` hint string does not modify or reset any values.
38913893

38923894
.. _class_@GlobalScope_constant_PROPERTY_HINT_INPUT_NAME:
38933895

‎classes/class_acceptdialog.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ Sets autowrapping for the text in the dialog.
177177
- |void| **set_close_on_escape**\ (\ value\: :ref:`bool<class_bool>`\ )
178178
- :ref:`bool<class_bool>` **get_close_on_escape**\ (\ )
179179

180-
If ``true``, the dialog will be hidden when the escape key (:ref:`@GlobalScope.KEY_ESCAPE<class_@GlobalScope_constant_KEY_ESCAPE>`) is pressed.
180+
If ``true``, the dialog will be hidden when the ``ui_cancel`` action is pressed (by default, this action is bound to :ref:`@GlobalScope.KEY_ESCAPE<class_@GlobalScope_constant_KEY_ESCAPE>`).
181181

182182
.. rst-class:: classref-item-separator
183183

‎classes/class_array.rst

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,8 @@ Methods
123123
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
124124
| :ref:`Array<class_Array>` | :ref:`duplicate<class_Array_method_duplicate>`\ (\ deep\: :ref:`bool<class_bool>` = false\ ) |const| |
125125
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
126+
| :ref:`Array<class_Array>` | :ref:`duplicate_deep<class_Array_method_duplicate_deep>`\ (\ deep_subresources_mode\: :ref:`int<class_int>` = 1\ ) |const| |
127+
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
126128
| |void| | :ref:`erase<class_Array_method_erase>`\ (\ value\: :ref:`Variant<class_Variant>`\ ) |
127129
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
128130
| |void| | :ref:`fill<class_Array_method_fill>`\ (\ value\: :ref:`Variant<class_Variant>`\ ) |
@@ -661,9 +663,23 @@ To count how many elements in an array satisfy a condition, see :ref:`reduce()<c
661663

662664
Returns a new copy of the array.
663665

664-
By default, a **shallow** copy is returned: all nested **Array** and :ref:`Dictionary<class_Dictionary>` elements are shared with the original array. Modifying them in one array will also affect them in the other.
666+
By default, a **shallow** copy is returned: all nested **Array**, :ref:`Dictionary<class_Dictionary>`, and :ref:`Resource<class_Resource>` elements are shared with the original array. Modifying any of those in one array will also affect them in the other.
667+
668+
If ``deep`` is ``true``, a **deep** copy is returned: all nested arrays and dictionaries are also duplicated (recursively). Any :ref:`Resource<class_Resource>` is still shared with the original array, though.
669+
670+
.. rst-class:: classref-item-separator
671+
672+
----
673+
674+
.. _class_Array_method_duplicate_deep:
675+
676+
.. rst-class:: classref-method
677+
678+
:ref:`Array<class_Array>` **duplicate_deep**\ (\ deep_subresources_mode\: :ref:`int<class_int>` = 1\ ) |const| :ref:`🔗<class_Array_method_duplicate_deep>`
679+
680+
Duplicates this array, deeply, like :ref:`duplicate()<class_Array_method_duplicate>`\ ``(true)``, with extra control over how subresources are handled.
665681

666-
If ``deep`` is ``true``, a **deep** copy is returned: all nested arrays and dictionaries are also duplicated (recursively).
682+
\ ``deep_subresources_mode`` must be one of the values from :ref:`ResourceDeepDuplicateMode<enum_Resource_ResourceDeepDuplicateMode>`. By default, only internal resources will be duplicated (recursively).
667683

668684
.. rst-class:: classref-item-separator
669685

‎classes/class_colorpicker.rst

Lines changed: 45 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ Properties
5151
+----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
5252
| :ref:`bool<class_bool>` | :ref:`edit_alpha<class_ColorPicker_property_edit_alpha>` | ``true`` |
5353
+----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
54+
| :ref:`bool<class_bool>` | :ref:`edit_intensity<class_ColorPicker_property_edit_intensity>` | ``true`` |
55+
+----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
5456
| :ref:`bool<class_bool>` | :ref:`hex_visible<class_ColorPicker_property_hex_visible>` | ``true`` |
5557
+----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
5658
| :ref:`PickerShapeType<enum_ColorPicker_PickerShapeType>` | :ref:`picker_shape<class_ColorPicker_property_picker_shape>` | ``0`` |
@@ -113,6 +115,8 @@ Theme Properties
113115
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
114116
| :ref:`Texture2D<class_Texture2D>` | :ref:`color_hue<class_ColorPicker_theme_icon_color_hue>` | |
115117
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
118+
| :ref:`Texture2D<class_Texture2D>` | :ref:`color_script<class_ColorPicker_theme_icon_color_script>` | |
119+
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
116120
| :ref:`Texture2D<class_Texture2D>` | :ref:`expanded_arrow<class_ColorPicker_theme_icon_expanded_arrow>` | |
117121
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
118122
| :ref:`Texture2D<class_Texture2D>` | :ref:`folded_arrow<class_ColorPicker_theme_icon_folded_arrow>` | |
@@ -206,7 +210,7 @@ enum **ColorModeType**: :ref:`🔗<enum_ColorPicker_ColorModeType>`
206210

207211
:ref:`ColorModeType<enum_ColorPicker_ColorModeType>` **MODE_RGB** = ``0``
208212

209-
Allows editing the color with Red/Green/Blue sliders.
213+
Allows editing the color with Red/Green/Blue sliders in sRGB color space.
210214

211215
.. _class_ColorPicker_constant_MODE_HSV:
212216

@@ -222,7 +226,17 @@ Allows editing the color with Hue/Saturation/Value sliders.
222226

223227
:ref:`ColorModeType<enum_ColorPicker_ColorModeType>` **MODE_RAW** = ``2``
224228

225-
Allows the color R, G, B component values to go beyond 1.0, which can be used for certain special operations that require it (like tinting without darkening or rendering sprites in HDR).
229+
**Deprecated:** This is replaced by :ref:`MODE_LINEAR<class_ColorPicker_constant_MODE_LINEAR>`.
230+
231+
232+
233+
.. _class_ColorPicker_constant_MODE_LINEAR:
234+
235+
.. rst-class:: classref-enumeration-constant
236+
237+
:ref:`ColorModeType<enum_ColorPicker_ColorModeType>` **MODE_LINEAR** = ``2``
238+
239+
Allows editing the color with Red/Green/Blue sliders in linear color space.
226240

227241
.. _class_ColorPicker_constant_MODE_OKHSL:
228242

@@ -397,6 +411,23 @@ If ``true``, shows an alpha channel slider (opacity).
397411

398412
----
399413

414+
.. _class_ColorPicker_property_edit_intensity:
415+
416+
.. rst-class:: classref-property
417+
418+
:ref:`bool<class_bool>` **edit_intensity** = ``true`` :ref:`🔗<class_ColorPicker_property_edit_intensity>`
419+
420+
.. rst-class:: classref-property-setget
421+
422+
- |void| **set_edit_intensity**\ (\ value\: :ref:`bool<class_bool>`\ )
423+
- :ref:`bool<class_bool>` **is_editing_intensity**\ (\ )
424+
425+
If ``true``, shows an intensity slider. The intensity is applied as follows: multiply the color by ``2 ** intensity`` in linear RGB space, and then convert it back to sRGB.
426+
427+
.. rst-class:: classref-item-separator
428+
429+
----
430+
400431
.. _class_ColorPicker_property_hex_visible:
401432

402433
.. rst-class:: classref-property
@@ -688,6 +719,18 @@ Custom texture for the hue selection slider on the right.
688719

689720
----
690721

722+
.. _class_ColorPicker_theme_icon_color_script:
723+
724+
.. rst-class:: classref-themeproperty
725+
726+
:ref:`Texture2D<class_Texture2D>` **color_script** :ref:`🔗<class_ColorPicker_theme_icon_color_script>`
727+
728+
The icon for the button that switches color text to hexadecimal.
729+
730+
.. rst-class:: classref-item-separator
731+
732+
----
733+
691734
.. _class_ColorPicker_theme_icon_expanded_arrow:
692735

693736
.. rst-class:: classref-themeproperty

‎classes/class_colorpickerbutton.rst

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,15 @@ Properties
4242
.. table::
4343
:widths: auto
4444

45-
+---------------------------+----------------------------------------------------------------+-------------------------------------------------------------------------------+
46-
| :ref:`Color<class_Color>` | :ref:`color<class_ColorPickerButton_property_color>` | ``Color(0, 0, 0, 1)`` |
47-
+---------------------------+----------------------------------------------------------------+-------------------------------------------------------------------------------+
48-
| :ref:`bool<class_bool>` | :ref:`edit_alpha<class_ColorPickerButton_property_edit_alpha>` | ``true`` |
49-
+---------------------------+----------------------------------------------------------------+-------------------------------------------------------------------------------+
50-
| :ref:`bool<class_bool>` | toggle_mode | ``true`` (overrides :ref:`BaseButton<class_BaseButton_property_toggle_mode>`) |
51-
+---------------------------+----------------------------------------------------------------+-------------------------------------------------------------------------------+
45+
+---------------------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+
46+
| :ref:`Color<class_Color>` | :ref:`color<class_ColorPickerButton_property_color>` | ``Color(0, 0, 0, 1)`` |
47+
+---------------------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+
48+
| :ref:`bool<class_bool>` | :ref:`edit_alpha<class_ColorPickerButton_property_edit_alpha>` | ``true`` |
49+
+---------------------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+
50+
| :ref:`bool<class_bool>` | :ref:`edit_intensity<class_ColorPickerButton_property_edit_intensity>` | ``true`` |
51+
+---------------------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+
52+
| :ref:`bool<class_bool>` | toggle_mode | ``true`` (overrides :ref:`BaseButton<class_BaseButton_property_toggle_mode>`) |
53+
+---------------------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+
5254

5355
.. rst-class:: classref-reftable-group
5456

@@ -156,6 +158,23 @@ The currently selected color.
156158

157159
If ``true``, the alpha channel in the displayed :ref:`ColorPicker<class_ColorPicker>` will be visible.
158160

161+
.. rst-class:: classref-item-separator
162+
163+
----
164+
165+
.. _class_ColorPickerButton_property_edit_intensity:
166+
167+
.. rst-class:: classref-property
168+
169+
:ref:`bool<class_bool>` **edit_intensity** = ``true`` :ref:`🔗<class_ColorPickerButton_property_edit_intensity>`
170+
171+
.. rst-class:: classref-property-setget
172+
173+
- |void| **set_edit_intensity**\ (\ value\: :ref:`bool<class_bool>`\ )
174+
- :ref:`bool<class_bool>` **is_editing_intensity**\ (\ )
175+
176+
If ``true``, the intensity slider in the displayed :ref:`ColorPicker<class_ColorPicker>` will be visible.
177+
159178
.. rst-class:: classref-section-separator
160179

161180
----

‎classes/class_dictionary.rst

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,8 @@ Methods
235235
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
236236
| :ref:`Dictionary<class_Dictionary>` | :ref:`duplicate<class_Dictionary_method_duplicate>`\ (\ deep\: :ref:`bool<class_bool>` = false\ ) |const| |
237237
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
238+
| :ref:`Dictionary<class_Dictionary>` | :ref:`duplicate_deep<class_Dictionary_method_duplicate_deep>`\ (\ deep_subresources_mode\: :ref:`int<class_int>` = 1\ ) |const| |
239+
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
238240
| :ref:`bool<class_bool>` | :ref:`erase<class_Dictionary_method_erase>`\ (\ key\: :ref:`Variant<class_Variant>`\ ) |
239241
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
240242
| :ref:`Variant<class_Variant>` | :ref:`find_key<class_Dictionary_method_find_key>`\ (\ value\: :ref:`Variant<class_Variant>`\ ) |const| |
@@ -388,7 +390,25 @@ Clears the dictionary, removing all entries from it.
388390

389391
:ref:`Dictionary<class_Dictionary>` **duplicate**\ (\ deep\: :ref:`bool<class_bool>` = false\ ) |const| :ref:`🔗<class_Dictionary_method_duplicate>`
390392

391-
Creates and returns a new copy of the dictionary. If ``deep`` is ``true``, inner **Dictionary** and :ref:`Array<class_Array>` keys and values are also copied, recursively.
393+
Returns a new copy of the dictionary.
394+
395+
By default, a **shallow** copy is returned: all nested :ref:`Array<class_Array>`, **Dictionary**, and :ref:`Resource<class_Resource>` keys and values are shared with the original dictionary. Modifying any of those in one dictionary will also affect them in the other.
396+
397+
If ``deep`` is ``true``, a **deep** copy is returned: all nested arrays and dictionaries are also duplicated (recursively). Any :ref:`Resource<class_Resource>` is still shared with the original dictionary, though.
398+
399+
.. rst-class:: classref-item-separator
400+
401+
----
402+
403+
.. _class_Dictionary_method_duplicate_deep:
404+
405+
.. rst-class:: classref-method
406+
407+
:ref:`Dictionary<class_Dictionary>` **duplicate_deep**\ (\ deep_subresources_mode\: :ref:`int<class_int>` = 1\ ) |const| :ref:`🔗<class_Dictionary_method_duplicate_deep>`
408+
409+
Duplicates this dictionary, deeply, like :ref:`duplicate()<class_Dictionary_method_duplicate>`\ ``(true)``, with extra control over how subresources are handled.
410+
411+
\ ``deep_subresources_mode`` must be one of the values from :ref:`ResourceDeepDuplicateMode<enum_Resource_ResourceDeepDuplicateMode>`. By default, only internal resources will be duplicated (recursively).
392412

393413
.. rst-class:: classref-item-separator
394414

‎classes/class_diraccess.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,8 @@ Methods
155155
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
156156
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_files_at<class_DirAccess_method_get_files_at>`\ (\ path\: :ref:`String<class_String>`\ ) |static| |
157157
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
158+
| :ref:`String<class_String>` | :ref:`get_filesystem_type<class_DirAccess_method_get_filesystem_type>`\ (\ ) |const| |
159+
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
158160
| :ref:`String<class_String>` | :ref:`get_next<class_DirAccess_method_get_next>`\ (\ ) |
159161
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
160162
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`get_open_error<class_DirAccess_method_get_open_error>`\ (\ ) |static| |
@@ -504,6 +506,20 @@ Use :ref:`get_files()<class_DirAccess_method_get_files>` if you want more contro
504506

505507
----
506508

509+
.. _class_DirAccess_method_get_filesystem_type:
510+
511+
.. rst-class:: classref-method
512+
513+
:ref:`String<class_String>` **get_filesystem_type**\ (\ ) |const| :ref:`🔗<class_DirAccess_method_get_filesystem_type>`
514+
515+
Returns file system type name of the current directory's disk. Returned values are uppercase strings like ``NTFS``, ``FAT32``, ``EXFAT``, ``APFS``, ``EXT4``, ``BTRFS``, and so on.
516+
517+
\ **Note:** This method is implemented on macOS, Linux, Windows and for PCK virtual file system.
518+
519+
.. rst-class:: classref-item-separator
520+
521+
----
522+
507523
.. _class_DirAccess_method_get_next:
508524

509525
.. rst-class:: classref-method

0 commit comments

Comments
 (0)