:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorFileDialog.xml. .. _class_EditorFileDialog: EditorFileDialog ================ **Inherits:** :ref:`ConfirmationDialog` **<** :ref:`AcceptDialog` **<** :ref:`Window` **<** :ref:`Viewport` **<** :ref:`Node` **<** :ref:`Object` A modified version of :ref:`FileDialog` used by the editor. .. rst-class:: classref-introduction-group Description ----------- **EditorFileDialog** is an enhanced version of :ref:`FileDialog` available only to editor plugins. Additional features include list of favorited/recent files and the ability to see files as thumbnails grid instead of list. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`Access` | :ref:`access` | ``0`` | +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`current_dir` | | +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`current_file` | | +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`current_path` | | +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`bool` | dialog_hide_on_ok | ``false`` (overrides :ref:`AcceptDialog`) | +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`disable_overwrite_warning` | ``false`` | +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`DisplayMode` | :ref:`display_mode` | ``0`` | +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`FileMode` | :ref:`file_mode` | ``4`` | +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`filters` | ``PackedStringArray()`` | +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`option_count` | ``0`` | +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`show_hidden_files` | ``false`` | +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`String` | title | ``"Save a File"`` (overrides :ref:`Window`) | +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_filter`\ (\ filter\: :ref:`String`, description\: :ref:`String` = ""\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_option`\ (\ name\: :ref:`String`, values\: :ref:`PackedStringArray`, default_value_index\: :ref:`int`\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_side_menu`\ (\ menu\: :ref:`Control`, title\: :ref:`String` = ""\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear_filters`\ (\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`LineEdit` | :ref:`get_line_edit`\ (\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_option_default`\ (\ option\: :ref:`int`\ ) |const| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_option_name`\ (\ option\: :ref:`int`\ ) |const| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`get_option_values`\ (\ option\: :ref:`int`\ ) |const| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_selected_options`\ (\ ) |const| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`VBoxContainer` | :ref:`get_vbox`\ (\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`invalidate`\ (\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`popup_file_dialog`\ (\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_option_default`\ (\ option\: :ref:`int`, default_value_index\: :ref:`int`\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_option_name`\ (\ option\: :ref:`int`, name\: :ref:`String`\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_option_values`\ (\ option\: :ref:`int`, values\: :ref:`PackedStringArray`\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_EditorFileDialog_signal_dir_selected: .. rst-class:: classref-signal **dir_selected**\ (\ dir\: :ref:`String`\ ) :ref:`🔗` Emitted when a directory is selected. .. rst-class:: classref-item-separator ---- .. _class_EditorFileDialog_signal_file_selected: .. rst-class:: classref-signal **file_selected**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Emitted when a file is selected. .. rst-class:: classref-item-separator ---- .. _class_EditorFileDialog_signal_files_selected: .. rst-class:: classref-signal **files_selected**\ (\ paths\: :ref:`PackedStringArray`\ ) :ref:`🔗` Emitted when multiple files are selected. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_EditorFileDialog_FileMode: .. rst-class:: classref-enumeration enum **FileMode**: :ref:`🔗` .. _class_EditorFileDialog_constant_FILE_MODE_OPEN_FILE: .. rst-class:: classref-enumeration-constant :ref:`FileMode` **FILE_MODE_OPEN_FILE** = ``0`` The **EditorFileDialog** can select only one file. Accepting the window will open the file. .. _class_EditorFileDialog_constant_FILE_MODE_OPEN_FILES: .. rst-class:: classref-enumeration-constant :ref:`FileMode` **FILE_MODE_OPEN_FILES** = ``1`` The **EditorFileDialog** can select multiple files. Accepting the window will open all files. .. _class_EditorFileDialog_constant_FILE_MODE_OPEN_DIR: .. rst-class:: classref-enumeration-constant :ref:`FileMode` **FILE_MODE_OPEN_DIR** = ``2`` The **EditorFileDialog** can select only one directory. Accepting the window will open the directory. .. _class_EditorFileDialog_constant_FILE_MODE_OPEN_ANY: .. rst-class:: classref-enumeration-constant :ref:`FileMode` **FILE_MODE_OPEN_ANY** = ``3`` The **EditorFileDialog** can select a file or directory. Accepting the window will open it. .. _class_EditorFileDialog_constant_FILE_MODE_SAVE_FILE: .. rst-class:: classref-enumeration-constant :ref:`FileMode` **FILE_MODE_SAVE_FILE** = ``4`` The **EditorFileDialog** can select only one file. Accepting the window will save the file. .. rst-class:: classref-item-separator ---- .. _enum_EditorFileDialog_Access: .. rst-class:: classref-enumeration enum **Access**: :ref:`🔗` .. _class_EditorFileDialog_constant_ACCESS_RESOURCES: .. rst-class:: classref-enumeration-constant :ref:`Access` **ACCESS_RESOURCES** = ``0`` The **EditorFileDialog** can only view ``res://`` directory contents. .. _class_EditorFileDialog_constant_ACCESS_USERDATA: .. rst-class:: classref-enumeration-constant :ref:`Access` **ACCESS_USERDATA** = ``1`` The **EditorFileDialog** can only view ``user://`` directory contents. .. _class_EditorFileDialog_constant_ACCESS_FILESYSTEM: .. rst-class:: classref-enumeration-constant :ref:`Access` **ACCESS_FILESYSTEM** = ``2`` The **EditorFileDialog** can view the entire local file system. .. rst-class:: classref-item-separator ---- .. _enum_EditorFileDialog_DisplayMode: .. rst-class:: classref-enumeration enum **DisplayMode**: :ref:`🔗` .. _class_EditorFileDialog_constant_DISPLAY_THUMBNAILS: .. rst-class:: classref-enumeration-constant :ref:`DisplayMode` **DISPLAY_THUMBNAILS** = ``0`` The **EditorFileDialog** displays resources as thumbnails. .. _class_EditorFileDialog_constant_DISPLAY_LIST: .. rst-class:: classref-enumeration-constant :ref:`DisplayMode` **DISPLAY_LIST** = ``1`` The **EditorFileDialog** displays resources as a list of filenames. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_EditorFileDialog_property_access: .. rst-class:: classref-property :ref:`Access` **access** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_access**\ (\ value\: :ref:`Access`\ ) - :ref:`Access` **get_access**\ (\ ) The location from which the user may select a file, including ``res://``, ``user://``, and the local file system. .. rst-class:: classref-item-separator ---- .. _class_EditorFileDialog_property_current_dir: .. rst-class:: classref-property :ref:`String` **current_dir** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_current_dir**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_current_dir**\ (\ ) The currently occupied directory. .. rst-class:: classref-item-separator ---- .. _class_EditorFileDialog_property_current_file: .. rst-class:: classref-property :ref:`String` **current_file** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_current_file**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_current_file**\ (\ ) The currently selected file. .. rst-class:: classref-item-separator ---- .. _class_EditorFileDialog_property_current_path: .. rst-class:: classref-property :ref:`String` **current_path** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_current_path**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_current_path**\ (\ ) The file system path in the address bar. .. rst-class:: classref-item-separator ---- .. _class_EditorFileDialog_property_disable_overwrite_warning: .. rst-class:: classref-property :ref:`bool` **disable_overwrite_warning** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_disable_overwrite_warning**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_overwrite_warning_disabled**\ (\ ) If ``true``, the **EditorFileDialog** will not warn the user before overwriting files. .. rst-class:: classref-item-separator ---- .. _class_EditorFileDialog_property_display_mode: .. rst-class:: classref-property :ref:`DisplayMode` **display_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_display_mode**\ (\ value\: :ref:`DisplayMode`\ ) - :ref:`DisplayMode` **get_display_mode**\ (\ ) The view format in which the **EditorFileDialog** displays resources to the user. .. rst-class:: classref-item-separator ---- .. _class_EditorFileDialog_property_file_mode: .. rst-class:: classref-property :ref:`FileMode` **file_mode** = ``4`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_file_mode**\ (\ value\: :ref:`FileMode`\ ) - :ref:`FileMode` **get_file_mode**\ (\ ) The dialog's open or save mode, which affects the selection behavior. See :ref:`FileMode`. .. rst-class:: classref-item-separator ---- .. _class_EditorFileDialog_property_filters: .. rst-class:: classref-property :ref:`PackedStringArray` **filters** = ``PackedStringArray()`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_filters**\ (\ value\: :ref:`PackedStringArray`\ ) - :ref:`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. **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedStringArray` for more details. .. rst-class:: classref-item-separator ---- .. _class_EditorFileDialog_property_option_count: .. rst-class:: classref-property :ref:`int` **option_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_option_count**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_option_count**\ (\ ) The number of additional :ref:`OptionButton`\ s and :ref:`CheckBox`\ es in the dialog. .. rst-class:: classref-item-separator ---- .. _class_EditorFileDialog_property_show_hidden_files: .. rst-class:: classref-property :ref:`bool` **show_hidden_files** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_show_hidden_files**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_showing_hidden_files**\ (\ ) If ``true``, hidden files and directories will be visible in the **EditorFileDialog**. This property is synchronized with :ref:`EditorSettings.filesystem/file_dialog/show_hidden_files`. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_EditorFileDialog_method_add_filter: .. rst-class:: classref-method |void| **add_filter**\ (\ filter\: :ref:`String`, description\: :ref:`String` = ""\ ) :ref:`🔗` Adds a comma-delimited file name ``filter`` option to the **EditorFileDialog** with an optional ``description``, which restricts what files can be picked. A ``filter`` should be of the form ``"filename.extension"``, where filename and extension can be ``*`` to match any string. Filters starting with ``.`` (i.e. empty filenames) are not allowed. For example, a ``filter`` of ``"*.tscn, *.scn"`` and a ``description`` of ``"Scenes"`` results in filter text "Scenes (\*.tscn, \*.scn)". .. rst-class:: classref-item-separator ---- .. _class_EditorFileDialog_method_add_option: .. rst-class:: classref-method |void| **add_option**\ (\ name\: :ref:`String`, values\: :ref:`PackedStringArray`, default_value_index\: :ref:`int`\ ) :ref:`🔗` Adds an additional :ref:`OptionButton` to the file dialog. If ``values`` is empty, a :ref:`CheckBox` is added instead. \ ``default_value_index`` should be an index of the value in the ``values``. If ``values`` is empty it should be either ``1`` (checked), or ``0`` (unchecked). .. rst-class:: classref-item-separator ---- .. _class_EditorFileDialog_method_add_side_menu: .. rst-class:: classref-method |void| **add_side_menu**\ (\ menu\: :ref:`Control`, title\: :ref:`String` = ""\ ) :ref:`🔗` Adds the given ``menu`` to the side of the file dialog with the given ``title`` text on top. Only one side menu is allowed. .. rst-class:: classref-item-separator ---- .. _class_EditorFileDialog_method_clear_filters: .. rst-class:: classref-method |void| **clear_filters**\ (\ ) :ref:`🔗` Removes all filters except for "All Files (\*)". .. rst-class:: classref-item-separator ---- .. _class_EditorFileDialog_method_get_line_edit: .. rst-class:: classref-method :ref:`LineEdit` **get_line_edit**\ (\ ) :ref:`🔗` Returns the LineEdit for the selected file. \ **Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`CanvasItem.visible` property. .. rst-class:: classref-item-separator ---- .. _class_EditorFileDialog_method_get_option_default: .. rst-class:: classref-method :ref:`int` **get_option_default**\ (\ option\: :ref:`int`\ ) |const| :ref:`🔗` Returns the default value index of the :ref:`OptionButton` or :ref:`CheckBox` with index ``option``. .. rst-class:: classref-item-separator ---- .. _class_EditorFileDialog_method_get_option_name: .. rst-class:: classref-method :ref:`String` **get_option_name**\ (\ option\: :ref:`int`\ ) |const| :ref:`🔗` Returns the name of the :ref:`OptionButton` or :ref:`CheckBox` with index ``option``. .. rst-class:: classref-item-separator ---- .. _class_EditorFileDialog_method_get_option_values: .. rst-class:: classref-method :ref:`PackedStringArray` **get_option_values**\ (\ option\: :ref:`int`\ ) |const| :ref:`🔗` Returns an array of values of the :ref:`OptionButton` with index ``option``. .. rst-class:: classref-item-separator ---- .. _class_EditorFileDialog_method_get_selected_options: .. rst-class:: classref-method :ref:`Dictionary` **get_selected_options**\ (\ ) |const| :ref:`🔗` Returns a :ref:`Dictionary` with the selected values of the additional :ref:`OptionButton`\ s and/or :ref:`CheckBox`\ es. :ref:`Dictionary` keys are names and values are selected value indices. .. rst-class:: classref-item-separator ---- .. _class_EditorFileDialog_method_get_vbox: .. rst-class:: classref-method :ref:`VBoxContainer` **get_vbox**\ (\ ) :ref:`🔗` Returns the :ref:`VBoxContainer` used to display the file system. \ **Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`CanvasItem.visible` property. .. rst-class:: classref-item-separator ---- .. _class_EditorFileDialog_method_invalidate: .. rst-class:: classref-method |void| **invalidate**\ (\ ) :ref:`🔗` Notify the **EditorFileDialog** that its view of the data is no longer accurate. Updates the view contents on next view update. .. rst-class:: classref-item-separator ---- .. _class_EditorFileDialog_method_popup_file_dialog: .. rst-class:: classref-method |void| **popup_file_dialog**\ (\ ) :ref:`🔗` Shows the **EditorFileDialog** at the default size and position for file dialogs in the editor, and selects the file name if there is a current file. .. rst-class:: classref-item-separator ---- .. _class_EditorFileDialog_method_set_option_default: .. rst-class:: classref-method |void| **set_option_default**\ (\ option\: :ref:`int`, default_value_index\: :ref:`int`\ ) :ref:`🔗` Sets the default value index of the :ref:`OptionButton` or :ref:`CheckBox` with index ``option``. .. rst-class:: classref-item-separator ---- .. _class_EditorFileDialog_method_set_option_name: .. rst-class:: classref-method |void| **set_option_name**\ (\ option\: :ref:`int`, name\: :ref:`String`\ ) :ref:`🔗` Sets the name of the :ref:`OptionButton` or :ref:`CheckBox` with index ``option``. .. rst-class:: classref-item-separator ---- .. _class_EditorFileDialog_method_set_option_values: .. rst-class:: classref-method |void| **set_option_values**\ (\ option\: :ref:`int`, values\: :ref:`PackedStringArray`\ ) :ref:`🔗` Sets the option values of the :ref:`OptionButton` with index ``option``. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |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.)`