Skip to content

classref: Sync with current master branch (17e7f85) #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

classref: Sync with current master branch (17e7f85) #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions classes/[email protected]
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7285,6 +7285,8 @@ Encodes a :ref:`Variant<class_Variant>` value to a byte array, without encoding

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

\ **Note:** Encoding :ref:`Callable<class_Callable>` is not supported and will result in an empty value, regardless of the data.

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

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

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>`.

\ **Note:** Encoding :ref:`Callable<class_Callable>` is not supported and will result in an empty value, regardless of the data.

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

----
Expand Down
2 changes: 2 additions & 0 deletions classes/class_animatedsprite2d.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,8 @@ Emitted when :ref:`animation<class_AnimatedSprite2D_property_animation>` changes

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

\ **Note:** This signal is not emitted if an animation is looping.

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

----
Expand Down
2 changes: 2 additions & 0 deletions classes/class_animatedsprite3d.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,8 @@ Emitted when :ref:`animation<class_AnimatedSprite3D_property_animation>` changes

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

\ **Note:** This signal is not emitted if an animation is looping.

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

----
Expand Down
716 changes: 374 additions & 342 deletions classes/class_displayserver.rst
View file
Open in desktop

Large diffs are not rendered by default.

16 changes: 14 additions & 2 deletions classes/class_editorplugin.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ Emitted when any project setting has changed.

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

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

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

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

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

Emitted when user closes a scene. The argument is file path to a closed scene.
Emitted when user closes a scene. The argument is a file path to the closed scene.

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

----

.. _class_EditorPlugin_signal_scene_saved:

.. rst-class:: classref-signal

**scene_saved** **(** :ref:`String<class_String>` filepath **)**

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>`.

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

Expand Down
2 changes: 0 additions & 2 deletions classes/class_engine.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -542,8 +542,6 @@ Returns the current engine version information in a Dictionary.

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

\ ``year`` - Holds the year the version was released in as an int

\ ``string`` - ``major`` + ``minor`` + ``patch`` + ``status`` + ``build`` in a single String

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:
Expand Down
157 changes: 144 additions & 13 deletions classes/class_filedialog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ Properties
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`mode_overrides_title<class_FileDialog_property_mode_overrides_title>` | ``true`` |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`option_count<class_FileDialog_property_option_count>` | ``0`` |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`root_subfolder<class_FileDialog_property_root_subfolder>` | ``""`` |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`show_hidden_files<class_FileDialog_property_show_hidden_files>` | ``false`` |
Expand All @@ -63,19 +65,35 @@ Methods
.. table::
:widths: auto

+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_filter<class_FileDialog_method_add_filter>` **(** :ref:`String<class_String>` filter, :ref:`String<class_String>` description="" **)** |
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_filters<class_FileDialog_method_clear_filters>` **(** **)** |
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`deselect_all<class_FileDialog_method_deselect_all>` **(** **)** |
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`LineEdit<class_LineEdit>` | :ref:`get_line_edit<class_FileDialog_method_get_line_edit>` **(** **)** |
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`VBoxContainer<class_VBoxContainer>` | :ref:`get_vbox<class_FileDialog_method_get_vbox>` **(** **)** |
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`invalidate<class_FileDialog_method_invalidate>` **(** **)** |
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_filter<class_FileDialog_method_add_filter>` **(** :ref:`String<class_String>` filter, :ref:`String<class_String>` description="" **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_option<class_FileDialog_method_add_option>` **(** :ref:`String<class_String>` name, :ref:`PackedStringArray<class_PackedStringArray>` values, :ref:`int<class_int>` index **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_filters<class_FileDialog_method_clear_filters>` **(** **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`deselect_all<class_FileDialog_method_deselect_all>` **(** **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`LineEdit<class_LineEdit>` | :ref:`get_line_edit<class_FileDialog_method_get_line_edit>` **(** **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_option_default<class_FileDialog_method_get_option_default>` **(** :ref:`int<class_int>` option **)** |const| |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_option_name<class_FileDialog_method_get_option_name>` **(** :ref:`int<class_int>` option **)** |const| |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_option_values<class_FileDialog_method_get_option_values>` **(** :ref:`int<class_int>` option **)** |const| |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`get_selected_options<class_FileDialog_method_get_selected_options>` **(** **)** |const| |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`VBoxContainer<class_VBoxContainer>` | :ref:`get_vbox<class_FileDialog_method_get_vbox>` **(** **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`invalidate<class_FileDialog_method_invalidate>` **(** **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_option_default<class_FileDialog_method_set_option_default>` **(** :ref:`int<class_int>` option, :ref:`int<class_int>` index **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_option_name<class_FileDialog_method_set_option_name>` **(** :ref:`int<class_int>` option, :ref:`String<class_String>` name **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_option_values<class_FileDialog_method_set_option_values>` **(** :ref:`int<class_int>` option, :ref:`PackedStringArray<class_PackedStringArray>` values **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

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

----

.. _class_FileDialog_property_option_count:

.. rst-class:: classref-property

:ref:`int<class_int>` **option_count** = ``0``

.. rst-class:: classref-property-setget

- void **set_option_count** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_option_count** **(** **)**

The number of additional :ref:`OptionButton<class_OptionButton>`\ s and :ref:`CheckBox<class_CheckBox>`\ es in the dialog.

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

----

.. _class_FileDialog_property_root_subfolder:

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

----

.. _class_FileDialog_method_add_option:

.. rst-class:: classref-method

void **add_option** **(** :ref:`String<class_String>` name, :ref:`PackedStringArray<class_PackedStringArray>` values, :ref:`int<class_int>` index **)**

Adds an additional :ref:`OptionButton<class_OptionButton>` to the file dialog. If ``values`` is empty, a :ref:`CheckBox<class_CheckBox>` is added instead.

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

----

.. _class_FileDialog_method_clear_filters:

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

----

.. _class_FileDialog_method_get_option_default:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_option_default** **(** :ref:`int<class_int>` option **)** |const|

Returns the default value index of the :ref:`OptionButton<class_OptionButton>` or :ref:`CheckBox<class_CheckBox>` with index ``option``.

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

----

.. _class_FileDialog_method_get_option_name:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_option_name** **(** :ref:`int<class_int>` option **)** |const|

Returns the name of the :ref:`OptionButton<class_OptionButton>` or :ref:`CheckBox<class_CheckBox>` with index ``option``.

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

----

.. _class_FileDialog_method_get_option_values:

.. rst-class:: classref-method

:ref:`PackedStringArray<class_PackedStringArray>` **get_option_values** **(** :ref:`int<class_int>` option **)** |const|

Returns an array of values of the :ref:`OptionButton<class_OptionButton>` with index ``option``.

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

----

.. _class_FileDialog_method_get_selected_options:

.. rst-class:: classref-method

:ref:`Dictionary<class_Dictionary>` **get_selected_options** **(** **)** |const|

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.

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

----

.. _class_FileDialog_method_get_vbox:

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

Invalidate and update the current dialog content list.

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

----

.. _class_FileDialog_method_set_option_default:

.. rst-class:: classref-method

void **set_option_default** **(** :ref:`int<class_int>` option, :ref:`int<class_int>` index **)**

Sets the default value index of the :ref:`OptionButton<class_OptionButton>` or :ref:`CheckBox<class_CheckBox>` with index ``option``.

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

----

.. _class_FileDialog_method_set_option_name:

.. rst-class:: classref-method

void **set_option_name** **(** :ref:`int<class_int>` option, :ref:`String<class_String>` name **)**

Sets the name of the :ref:`OptionButton<class_OptionButton>` or :ref:`CheckBox<class_CheckBox>` with index ``option``.

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

----

.. _class_FileDialog_method_set_option_values:

.. rst-class:: classref-method

void **set_option_values** **(** :ref:`int<class_int>` option, :ref:`PackedStringArray<class_PackedStringArray>` values **)**

Sets the option values of the :ref:`OptionButton<class_OptionButton>` with index ``option``.

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

----
Expand Down
Loading