Skip to content

Commit fcfc613

Browse files
author
Godot Organization
committed
classref: Sync with current master branch (17e7f85)
1 parent 515d22d commit fcfc613

29 files changed

+837
-495
lines changed

‎classes/[email protected]‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7285,6 +7285,8 @@ Encodes a :ref:`Variant<class_Variant>` value to a byte array, without encoding
72857285

72867286
\ **Note:** If you need object serialization, see :ref:`var_to_bytes_with_objects<class_@GlobalScope_method_var_to_bytes_with_objects>`.
72877287

7288+
\ **Note:** Encoding :ref:`Callable<class_Callable>` is not supported and will result in an empty value, regardless of the data.
7289+
72887290
.. rst-class:: classref-item-separator
72897291

72907292
----
@@ -7297,6 +7299,8 @@ Encodes a :ref:`Variant<class_Variant>` value to a byte array, without encoding
72977299

72987300
Encodes a :ref:`Variant<class_Variant>` value to a byte array. Encoding objects is allowed (and can potentially include executable code). Deserialization can be done with :ref:`bytes_to_var_with_objects<class_@GlobalScope_method_bytes_to_var_with_objects>`.
72997301

7302+
\ **Note:** Encoding :ref:`Callable<class_Callable>` is not supported and will result in an empty value, regardless of the data.
7303+
73007304
.. rst-class:: classref-item-separator
73017305

73027306
----

‎classes/class_animatedsprite2d.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,8 @@ Emitted when :ref:`animation<class_AnimatedSprite2D_property_animation>` changes
113113

114114
Emitted when the animation reaches the end, or the start if it is played in reverse. When the animation finishes, it pauses the playback.
115115

116+
\ **Note:** This signal is not emitted if an animation is looping.
117+
116118
.. rst-class:: classref-item-separator
117119

118120
----

‎classes/class_animatedsprite3d.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,8 @@ Emitted when :ref:`animation<class_AnimatedSprite3D_property_animation>` changes
103103

104104
Emitted when the animation reaches the end, or the start if it is played in reverse. When the animation finishes, it pauses the playback.
105105

106+
\ **Note:** This signal is not emitted if an animation is looping.
107+
106108
.. rst-class:: classref-item-separator
107109

108110
----

‎classes/class_displayserver.rst‎

Lines changed: 374 additions & 342 deletions
Large diffs are not rendered by default.

‎classes/class_editorplugin.rst‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ Emitted when any project setting has changed.
217217

218218
**resource_saved** **(** :ref:`Resource<class_Resource>` resource **)**
219219

220-
Emitted when the given ``resource`` was saved on disc.
220+
Emitted when the given ``resource`` was saved on disc. See also :ref:`scene_saved<class_EditorPlugin_signal_scene_saved>`.
221221

222222
.. rst-class:: classref-item-separator
223223

@@ -241,7 +241,19 @@ Emitted when the scene is changed in the editor. The argument will return the ro
241241

242242
**scene_closed** **(** :ref:`String<class_String>` filepath **)**
243243

244-
Emitted when user closes a scene. The argument is file path to a closed scene.
244+
Emitted when user closes a scene. The argument is a file path to the closed scene.
245+
246+
.. rst-class:: classref-item-separator
247+
248+
----
249+
250+
.. _class_EditorPlugin_signal_scene_saved:
251+
252+
.. rst-class:: classref-signal
253+
254+
**scene_saved** **(** :ref:`String<class_String>` filepath **)**
255+
256+
Emitted when a scene was saved on disc. The argument is a file path to the saved scene. See also :ref:`resource_saved<class_EditorPlugin_signal_resource_saved>`.
245257

246258
.. rst-class:: classref-section-separator
247259

‎classes/class_engine.rst‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -542,8 +542,6 @@ Returns the current engine version information in a Dictionary.
542542

543543
\ ``hash`` - Holds the full Git commit hash as a String
544544

545-
\ ``year`` - Holds the year the version was released in as an int
546-
547545
\ ``string`` - ``major`` + ``minor`` + ``patch`` + ``status`` + ``build`` in a single String
548546

549547
The ``hex`` value is encoded as follows, from left to right: one byte for the major, one byte for the minor, one byte for the patch version. For example, "3.1.12" would be ``0x03010C``. **Note:** It's still an int internally, and printing it will give you its decimal representation, which is not particularly meaningful. Use hexadecimal literals for easy version comparisons from code:

‎classes/class_filedialog.rst‎

Lines changed: 144 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ Properties
4646
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
4747
| :ref:`bool<class_bool>` | :ref:`mode_overrides_title<class_FileDialog_property_mode_overrides_title>` | ``true`` |
4848
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
49+
| :ref:`int<class_int>` | :ref:`option_count<class_FileDialog_property_option_count>` | ``0`` |
50+
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
4951
| :ref:`String<class_String>` | :ref:`root_subfolder<class_FileDialog_property_root_subfolder>` | ``""`` |
5052
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
5153
| :ref:`bool<class_bool>` | :ref:`show_hidden_files<class_FileDialog_property_show_hidden_files>` | ``false`` |
@@ -63,19 +65,35 @@ Methods
6365
.. table::
6466
:widths: auto
6567

66-
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
67-
| void | :ref:`add_filter<class_FileDialog_method_add_filter>` **(** :ref:`String<class_String>` filter, :ref:`String<class_String>` description="" **)** |
68-
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
69-
| void | :ref:`clear_filters<class_FileDialog_method_clear_filters>` **(** **)** |
70-
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
71-
| void | :ref:`deselect_all<class_FileDialog_method_deselect_all>` **(** **)** |
72-
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
73-
| :ref:`LineEdit<class_LineEdit>` | :ref:`get_line_edit<class_FileDialog_method_get_line_edit>` **(** **)** |
74-
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
75-
| :ref:`VBoxContainer<class_VBoxContainer>` | :ref:`get_vbox<class_FileDialog_method_get_vbox>` **(** **)** |
76-
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
77-
| void | :ref:`invalidate<class_FileDialog_method_invalidate>` **(** **)** |
78-
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
68+
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
69+
| void | :ref:`add_filter<class_FileDialog_method_add_filter>` **(** :ref:`String<class_String>` filter, :ref:`String<class_String>` description="" **)** |
70+
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
71+
| void | :ref:`add_option<class_FileDialog_method_add_option>` **(** :ref:`String<class_String>` name, :ref:`PackedStringArray<class_PackedStringArray>` values, :ref:`int<class_int>` index **)** |
72+
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
73+
| void | :ref:`clear_filters<class_FileDialog_method_clear_filters>` **(** **)** |
74+
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
75+
| void | :ref:`deselect_all<class_FileDialog_method_deselect_all>` **(** **)** |
76+
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
77+
| :ref:`LineEdit<class_LineEdit>` | :ref:`get_line_edit<class_FileDialog_method_get_line_edit>` **(** **)** |
78+
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
79+
| :ref:`int<class_int>` | :ref:`get_option_default<class_FileDialog_method_get_option_default>` **(** :ref:`int<class_int>` option **)** |const| |
80+
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
81+
| :ref:`String<class_String>` | :ref:`get_option_name<class_FileDialog_method_get_option_name>` **(** :ref:`int<class_int>` option **)** |const| |
82+
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
83+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_option_values<class_FileDialog_method_get_option_values>` **(** :ref:`int<class_int>` option **)** |const| |
84+
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
85+
| :ref:`Dictionary<class_Dictionary>` | :ref:`get_selected_options<class_FileDialog_method_get_selected_options>` **(** **)** |const| |
86+
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
87+
| :ref:`VBoxContainer<class_VBoxContainer>` | :ref:`get_vbox<class_FileDialog_method_get_vbox>` **(** **)** |
88+
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
89+
| void | :ref:`invalidate<class_FileDialog_method_invalidate>` **(** **)** |
90+
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
91+
| void | :ref:`set_option_default<class_FileDialog_method_set_option_default>` **(** :ref:`int<class_int>` option, :ref:`int<class_int>` index **)** |
92+
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
93+
| void | :ref:`set_option_name<class_FileDialog_method_set_option_name>` **(** :ref:`int<class_int>` option, :ref:`String<class_String>` name **)** |
94+
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
95+
| void | :ref:`set_option_values<class_FileDialog_method_set_option_values>` **(** :ref:`int<class_int>` option, :ref:`PackedStringArray<class_PackedStringArray>` values **)** |
96+
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
7997

8098
.. rst-class:: classref-reftable-group
8199

@@ -367,6 +385,23 @@ If ``true``, changing the :ref:`file_mode<class_FileDialog_property_file_mode>`
367385

368386
----
369387

388+
.. _class_FileDialog_property_option_count:
389+
390+
.. rst-class:: classref-property
391+
392+
:ref:`int<class_int>` **option_count** = ``0``
393+
394+
.. rst-class:: classref-property-setget
395+
396+
- void **set_option_count** **(** :ref:`int<class_int>` value **)**
397+
- :ref:`int<class_int>` **get_option_count** **(** **)**
398+
399+
The number of additional :ref:`OptionButton<class_OptionButton>`\ s and :ref:`CheckBox<class_CheckBox>`\ es in the dialog.
400+
401+
.. rst-class:: classref-item-separator
402+
403+
----
404+
370405
.. _class_FileDialog_property_root_subfolder:
371406

372407
.. rst-class:: classref-property
@@ -441,6 +476,18 @@ For example, a ``filter`` of ``"*.png, *.jpg"`` and a ``description`` of ``"Imag
441476

442477
----
443478

479+
.. _class_FileDialog_method_add_option:
480+
481+
.. rst-class:: classref-method
482+
483+
void **add_option** **(** :ref:`String<class_String>` name, :ref:`PackedStringArray<class_PackedStringArray>` values, :ref:`int<class_int>` index **)**
484+
485+
Adds an additional :ref:`OptionButton<class_OptionButton>` to the file dialog. If ``values`` is empty, a :ref:`CheckBox<class_CheckBox>` is added instead.
486+
487+
.. rst-class:: classref-item-separator
488+
489+
----
490+
444491
.. _class_FileDialog_method_clear_filters:
445492

446493
.. rst-class:: classref-method
@@ -479,6 +526,54 @@ Returns the LineEdit for the selected file.
479526

480527
----
481528

529+
.. _class_FileDialog_method_get_option_default:
530+
531+
.. rst-class:: classref-method
532+
533+
:ref:`int<class_int>` **get_option_default** **(** :ref:`int<class_int>` option **)** |const|
534+
535+
Returns the default value index of the :ref:`OptionButton<class_OptionButton>` or :ref:`CheckBox<class_CheckBox>` with index ``option``.
536+
537+
.. rst-class:: classref-item-separator
538+
539+
----
540+
541+
.. _class_FileDialog_method_get_option_name:
542+
543+
.. rst-class:: classref-method
544+
545+
:ref:`String<class_String>` **get_option_name** **(** :ref:`int<class_int>` option **)** |const|
546+
547+
Returns the name of the :ref:`OptionButton<class_OptionButton>` or :ref:`CheckBox<class_CheckBox>` with index ``option``.
548+
549+
.. rst-class:: classref-item-separator
550+
551+
----
552+
553+
.. _class_FileDialog_method_get_option_values:
554+
555+
.. rst-class:: classref-method
556+
557+
:ref:`PackedStringArray<class_PackedStringArray>` **get_option_values** **(** :ref:`int<class_int>` option **)** |const|
558+
559+
Returns an array of values of the :ref:`OptionButton<class_OptionButton>` with index ``option``.
560+
561+
.. rst-class:: classref-item-separator
562+
563+
----
564+
565+
.. _class_FileDialog_method_get_selected_options:
566+
567+
.. rst-class:: classref-method
568+
569+
:ref:`Dictionary<class_Dictionary>` **get_selected_options** **(** **)** |const|
570+
571+
Returns a :ref:`Dictionary<class_Dictionary>` with the selected values of the additional :ref:`OptionButton<class_OptionButton>`\ s and/or :ref:`CheckBox<class_CheckBox>`\ es. :ref:`Dictionary<class_Dictionary>` keys are names and values are selected value indices.
572+
573+
.. rst-class:: classref-item-separator
574+
575+
----
576+
482577
.. _class_FileDialog_method_get_vbox:
483578

484579
.. rst-class:: classref-method
@@ -501,6 +596,42 @@ void **invalidate** **(** **)**
501596

502597
Invalidate and update the current dialog content list.
503598

599+
.. rst-class:: classref-item-separator
600+
601+
----
602+
603+
.. _class_FileDialog_method_set_option_default:
604+
605+
.. rst-class:: classref-method
606+
607+
void **set_option_default** **(** :ref:`int<class_int>` option, :ref:`int<class_int>` index **)**
608+
609+
Sets the default value index of the :ref:`OptionButton<class_OptionButton>` or :ref:`CheckBox<class_CheckBox>` with index ``option``.
610+
611+
.. rst-class:: classref-item-separator
612+
613+
----
614+
615+
.. _class_FileDialog_method_set_option_name:
616+
617+
.. rst-class:: classref-method
618+
619+
void **set_option_name** **(** :ref:`int<class_int>` option, :ref:`String<class_String>` name **)**
620+
621+
Sets the name of the :ref:`OptionButton<class_OptionButton>` or :ref:`CheckBox<class_CheckBox>` with index ``option``.
622+
623+
.. rst-class:: classref-item-separator
624+
625+
----
626+
627+
.. _class_FileDialog_method_set_option_values:
628+
629+
.. rst-class:: classref-method
630+
631+
void **set_option_values** **(** :ref:`int<class_int>` option, :ref:`PackedStringArray<class_PackedStringArray>` values **)**
632+
633+
Sets the option values of the :ref:`OptionButton<class_OptionButton>` with index ``option``.
634+
504635
.. rst-class:: classref-section-separator
505636

506637
----

0 commit comments

Comments
 (0)