godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (2e7fc81)

Browse Source
This commit is contained in:
Godot Organization
2024-02-24 03:20:02 +00:00
parent 4f21f44632
commit 8978497bb6
938 changed files with 42729 additions and 36889 deletions
Download Patch File Download Diff File Expand all files Collapse all files

137
classes/class_filedialog.rst
View File

@@ -65,35 +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:`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 **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_filter<class_FileDialog_method_add_filter>`\ (\ filter\: :ref:`String<class_String>`, description\: :ref:`String<class_String>` = ""\ ) |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_option<class_FileDialog_method_add_option>`\ (\ name\: :ref:`String<class_String>`, values\: :ref:`PackedStringArray<class_PackedStringArray>`, index\: :ref:`int<class_int>`\ ) |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |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>`\ (\ option\: :ref:`int<class_int>`\ ) |const| |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_option_name<class_FileDialog_method_get_option_name>`\ (\ option\: :ref:`int<class_int>`\ ) |const| |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_option_values<class_FileDialog_method_get_option_values>`\ (\ option\: :ref:`int<class_int>`\ ) |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>`\ (\ option\: :ref:`int<class_int>`, index\: :ref:`int<class_int>`\ ) |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_option_name<class_FileDialog_method_set_option_name>`\ (\ option\: :ref:`int<class_int>`, name\: :ref:`String<class_String>`\ ) |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_option_values<class_FileDialog_method_set_option_values>`\ (\ option\: :ref:`int<class_int>`, values\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-reftable-group
@@ -138,7 +138,7 @@ Signals
.. rst-class:: classref-signal
**dir_selected** **(** :ref:`String<class_String>` dir **)**
**dir_selected**\ (\ dir\: :ref:`String<class_String>`\ )
Emitted when the user selects a directory.
@@ -150,7 +150,7 @@ Emitted when the user selects a directory.
.. rst-class:: classref-signal
**file_selected** **(** :ref:`String<class_String>` path **)**
**file_selected**\ (\ path\: :ref:`String<class_String>`\ )
Emitted when the user selects a file by double-clicking it or pressing the **OK** button.
@@ -162,7 +162,7 @@ Emitted when the user selects a file by double-clicking it or pressing the **OK*
.. rst-class:: classref-signal
**files_selected** **(** :ref:`PackedStringArray<class_PackedStringArray>` paths **)**
**files_selected**\ (\ paths\: :ref:`PackedStringArray<class_PackedStringArray>`\ )
Emitted when the user selects multiple files.
@@ -272,8 +272,8 @@ Property Descriptions
.. rst-class:: classref-property-setget
- void **set_access** **(** :ref:`Access<enum_FileDialog_Access>` value **)**
- :ref:`Access<enum_FileDialog_Access>` **get_access** **(** **)**
- |void| **set_access**\ (\ value\: :ref:`Access<enum_FileDialog_Access>`\ )
- :ref:`Access<enum_FileDialog_Access>` **get_access**\ (\ )
The file system access scope. See :ref:`Access<enum_FileDialog_Access>` constants.
@@ -291,8 +291,8 @@ The file system access scope. See :ref:`Access<enum_FileDialog_Access>` constant
.. rst-class:: classref-property-setget
- void **set_current_dir** **(** :ref:`String<class_String>` value **)**
- :ref:`String<class_String>` **get_current_dir** **(** **)**
- |void| **set_current_dir**\ (\ value\: :ref:`String<class_String>`\ )
- :ref:`String<class_String>` **get_current_dir**\ (\ )
The current working directory of the file dialog.
@@ -308,8 +308,8 @@ The current working directory of the file dialog.
.. rst-class:: classref-property-setget
- void **set_current_file** **(** :ref:`String<class_String>` value **)**
- :ref:`String<class_String>` **get_current_file** **(** **)**
- |void| **set_current_file**\ (\ value\: :ref:`String<class_String>`\ )
- :ref:`String<class_String>` **get_current_file**\ (\ )
The currently selected file of the file dialog.
@@ -325,8 +325,8 @@ The currently selected file of the file dialog.
.. rst-class:: classref-property-setget
- void **set_current_path** **(** :ref:`String<class_String>` value **)**
- :ref:`String<class_String>` **get_current_path** **(** **)**
- |void| **set_current_path**\ (\ value\: :ref:`String<class_String>`\ )
- :ref:`String<class_String>` **get_current_path**\ (\ )
The currently selected file path of the file dialog.
@@ -342,8 +342,8 @@ The currently selected file path of the file dialog.
.. rst-class:: classref-property-setget
- void **set_file_mode** **(** :ref:`FileMode<enum_FileDialog_FileMode>` value **)**
- :ref:`FileMode<enum_FileDialog_FileMode>` **get_file_mode** **(** **)**
- |void| **set_file_mode**\ (\ value\: :ref:`FileMode<enum_FileDialog_FileMode>`\ )
- :ref:`FileMode<enum_FileDialog_FileMode>` **get_file_mode**\ (\ )
The dialog's open or save mode, which affects the selection behavior. See :ref:`FileMode<enum_FileDialog_FileMode>`.
@@ -359,8 +359,8 @@ The dialog's open or save mode, which affects the selection behavior. See :ref:`
.. rst-class:: classref-property-setget
- void **set_filters** **(** :ref:`PackedStringArray<class_PackedStringArray>` value **)**
- :ref:`PackedStringArray<class_PackedStringArray>` **get_filters** **(** **)**
- |void| **set_filters**\ (\ value\: :ref:`PackedStringArray<class_PackedStringArray>`\ )
- :ref:`PackedStringArray<class_PackedStringArray>` **get_filters**\ (\ )
The available file type filters. For example, this shows only ``.png`` and ``.gd`` files: ``set_filters(PackedStringArray(["*.png ; PNG Images","*.gd ; GDScript Files"]))``. Multiple file types can also be specified in a single filter. ``"*.png, *.jpg, *.jpeg ; Supported Images"`` will show both PNG and JPEG files when selected.
@@ -376,8 +376,8 @@ The available file type filters. For example, this shows only ``.png`` and ``.gd
.. rst-class:: classref-property-setget
- void **set_mode_overrides_title** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_mode_overriding_title** **(** **)**
- |void| **set_mode_overrides_title**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_mode_overriding_title**\ (\ )
If ``true``, changing the :ref:`file_mode<class_FileDialog_property_file_mode>` property will set the window title accordingly (e.g. setting :ref:`file_mode<class_FileDialog_property_file_mode>` to :ref:`FILE_MODE_OPEN_FILE<class_FileDialog_constant_FILE_MODE_OPEN_FILE>` will change the window title to "Open a File").
@@ -393,8 +393,8 @@ If ``true``, changing the :ref:`file_mode<class_FileDialog_property_file_mode>`
.. rst-class:: classref-property-setget
- void **set_option_count** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_option_count** **(** **)**
- |void| **set_option_count**\ (\ value\: :ref:`int<class_int>`\ )
- :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.
@@ -410,8 +410,8 @@ The number of additional :ref:`OptionButton<class_OptionButton>`\ s and :ref:`Ch
.. rst-class:: classref-property-setget
- void **set_root_subfolder** **(** :ref:`String<class_String>` value **)**
- :ref:`String<class_String>` **get_root_subfolder** **(** **)**
- |void| **set_root_subfolder**\ (\ value\: :ref:`String<class_String>`\ )
- :ref:`String<class_String>` **get_root_subfolder**\ (\ )
If non-empty, the given sub-folder will be "root" of this **FileDialog**, i.e. user won't be able to go to its parent directory.
@@ -427,8 +427,8 @@ If non-empty, the given sub-folder will be "root" of this **FileDialog**, i.e. u
.. rst-class:: classref-property-setget
- void **set_show_hidden_files** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_showing_hidden_files** **(** **)**
- |void| **set_show_hidden_files**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_showing_hidden_files**\ (\ )
If ``true``, the dialog will show hidden files.
@@ -444,8 +444,8 @@ If ``true``, the dialog will show hidden files.
.. rst-class:: classref-property-setget
- void **set_use_native_dialog** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **get_use_native_dialog** **(** **)**
- |void| **set_use_native_dialog**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_use_native_dialog**\ (\ )
If ``true``, :ref:`access<class_FileDialog_property_access>` is set to :ref:`ACCESS_FILESYSTEM<class_FileDialog_constant_ACCESS_FILESYSTEM>`, and it is supported by the current :ref:`DisplayServer<class_DisplayServer>`, OS native dialog will be used instead of custom one.
@@ -464,7 +464,7 @@ Method Descriptions
.. rst-class:: classref-method
void **add_filter** **(** :ref:`String<class_String>` filter, :ref:`String<class_String>` description="" **)**
|void| **add_filter**\ (\ filter\: :ref:`String<class_String>`, description\: :ref:`String<class_String>` = ""\ )
Adds a comma-delimited file name ``filter`` option to the **FileDialog** with an optional ``description``, which restricts what files can be picked.
@@ -480,7 +480,7 @@ For example, a ``filter`` of ``"*.png, *.jpg"`` and a ``description`` of ``"Imag
.. rst-class:: classref-method
void **add_option** **(** :ref:`String<class_String>` name, :ref:`PackedStringArray<class_PackedStringArray>` values, :ref:`int<class_int>` index **)**
|void| **add_option**\ (\ name\: :ref:`String<class_String>`, values\: :ref:`PackedStringArray<class_PackedStringArray>`, index\: :ref:`int<class_int>`\ )
Adds an additional :ref:`OptionButton<class_OptionButton>` to the file dialog. If ``values`` is empty, a :ref:`CheckBox<class_CheckBox>` is added instead.
@@ -492,7 +492,7 @@ Adds an additional :ref:`OptionButton<class_OptionButton>` to the file dialog. I
.. rst-class:: classref-method
void **clear_filters** **(** **)**
|void| **clear_filters**\ (\ )
Clear all the added filters in the dialog.
@@ -504,7 +504,7 @@ Clear all the added filters in the dialog.
.. rst-class:: classref-method
void **deselect_all** **(** **)**
|void| **deselect_all**\ (\ )
Clear all currently selected items in the dialog.
@@ -516,7 +516,7 @@ Clear all currently selected items in the dialog.
.. rst-class:: classref-method
:ref:`LineEdit<class_LineEdit>` **get_line_edit** **(** **)**
:ref:`LineEdit<class_LineEdit>` **get_line_edit**\ (\ )
Returns the LineEdit for the selected file.
@@ -530,7 +530,7 @@ Returns the LineEdit for the selected file.
.. rst-class:: classref-method
:ref:`int<class_int>` **get_option_default** **(** :ref:`int<class_int>` option **)** |const|
:ref:`int<class_int>` **get_option_default**\ (\ option\: :ref:`int<class_int>`\ ) |const|
Returns the default value index of the :ref:`OptionButton<class_OptionButton>` or :ref:`CheckBox<class_CheckBox>` with index ``option``.
@@ -542,7 +542,7 @@ Returns the default value index of the :ref:`OptionButton<class_OptionButton>` o
.. rst-class:: classref-method
:ref:`String<class_String>` **get_option_name** **(** :ref:`int<class_int>` option **)** |const|
:ref:`String<class_String>` **get_option_name**\ (\ option\: :ref:`int<class_int>`\ ) |const|
Returns the name of the :ref:`OptionButton<class_OptionButton>` or :ref:`CheckBox<class_CheckBox>` with index ``option``.
@@ -554,7 +554,7 @@ Returns the name of the :ref:`OptionButton<class_OptionButton>` or :ref:`CheckBo
.. rst-class:: classref-method
:ref:`PackedStringArray<class_PackedStringArray>` **get_option_values** **(** :ref:`int<class_int>` option **)** |const|
:ref:`PackedStringArray<class_PackedStringArray>` **get_option_values**\ (\ option\: :ref:`int<class_int>`\ ) |const|
Returns an array of values of the :ref:`OptionButton<class_OptionButton>` with index ``option``.
@@ -566,7 +566,7 @@ Returns an array of values of the :ref:`OptionButton<class_OptionButton>` with i
.. rst-class:: classref-method
:ref:`Dictionary<class_Dictionary>` **get_selected_options** **(** **)** |const|
: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.
@@ -578,7 +578,7 @@ Returns a :ref:`Dictionary<class_Dictionary>` with the selected values of the ad
.. rst-class:: classref-method
:ref:`VBoxContainer<class_VBoxContainer>` **get_vbox** **(** **)**
:ref:`VBoxContainer<class_VBoxContainer>` **get_vbox**\ (\ )
Returns the vertical box container of the dialog, custom controls can be added to it.
@@ -592,7 +592,7 @@ Returns the vertical box container of the dialog, custom controls can be added t
.. rst-class:: classref-method
void **invalidate** **(** **)**
|void| **invalidate**\ (\ )
Invalidate and update the current dialog content list.
@@ -604,7 +604,7 @@ Invalidate and update the current dialog content list.
.. rst-class:: classref-method
void **set_option_default** **(** :ref:`int<class_int>` option, :ref:`int<class_int>` index **)**
|void| **set_option_default**\ (\ option\: :ref:`int<class_int>`, index\: :ref:`int<class_int>`\ )
Sets the default value index of the :ref:`OptionButton<class_OptionButton>` or :ref:`CheckBox<class_CheckBox>` with index ``option``.
@@ -616,7 +616,7 @@ Sets the default value index of the :ref:`OptionButton<class_OptionButton>` or :
.. rst-class:: classref-method
void **set_option_name** **(** :ref:`int<class_int>` option, :ref:`String<class_String>` name **)**
|void| **set_option_name**\ (\ option\: :ref:`int<class_int>`, name\: :ref:`String<class_String>`\ )
Sets the name of the :ref:`OptionButton<class_OptionButton>` or :ref:`CheckBox<class_CheckBox>` with index ``option``.
@@ -628,7 +628,7 @@ Sets the name of the :ref:`OptionButton<class_OptionButton>` or :ref:`CheckBox<c
.. rst-class:: classref-method
void **set_option_values** **(** :ref:`int<class_int>` option, :ref:`PackedStringArray<class_PackedStringArray>` values **)**
|void| **set_option_values**\ (\ option\: :ref:`int<class_int>`, values\: :ref:`PackedStringArray<class_PackedStringArray>`\ )
Sets the option values of the :ref:`OptionButton<class_OptionButton>` with index ``option``.
@@ -764,3 +764,4 @@ Custom icon for the toggle hidden button.
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
.. |void| replace:: :abbr:`void (No return value.)`