:github_url: hide .. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the EditorFileDialog.xml source instead. .. The source is found in doc/classes or modules//doc_classes. .. _class_EditorFileDialog: EditorFileDialog ================ **Inherits:** :ref:`ConfirmationDialog` **<** :ref:`AcceptDialog` **<** :ref:`WindowDialog` **<** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` A modified version of :ref:`FileDialog` used by the editor. Properties ---------- +-------------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------------+ | :ref:`Access` | :ref:`access` | ``0`` | +-------------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------------+ | :ref:`String` | :ref:`current_dir` | ``"res://"`` | +-------------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------------+ | :ref:`String` | :ref:`current_file` | ``""`` | +-------------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------------+ | :ref:`String` | :ref:`current_path` | ``"res://"`` | +-------------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------------+ | :ref:`bool` | dialog_hide_on_ok | ``false`` *(parent override)* | +-------------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------------+ | :ref:`bool` | :ref:`disable_overwrite_warning` | ``false`` | +-------------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------------+ | :ref:`DisplayMode` | :ref:`display_mode` | ``0`` | +-------------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------------+ | :ref:`Mode` | :ref:`mode` | ``4`` | +-------------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------------+ | :ref:`bool` | resizable | ``true`` *(parent override)* | +-------------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------------+ | :ref:`bool` | :ref:`show_hidden_files` | ``false`` | +-------------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------------+ | :ref:`String` | window_title | ``"Save a File"`` *(parent override)* | +-------------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------------+ Methods ------- +-------------------------------------------+------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_filter` **(** :ref:`String` filter **)** | +-------------------------------------------+------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_filters` **(** **)** | +-------------------------------------------+------------------------------------------------------------------------------------------------------------+ | :ref:`VBoxContainer` | :ref:`get_vbox` **(** **)** | +-------------------------------------------+------------------------------------------------------------------------------------------------------------+ | void | :ref:`invalidate` **(** **)** | +-------------------------------------------+------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_EditorFileDialog_signal_dir_selected: - **dir_selected** **(** :ref:`String` dir **)** Emitted when a directory is selected. ---- .. _class_EditorFileDialog_signal_file_selected: - **file_selected** **(** :ref:`String` path **)** Emitted when a file is selected. ---- .. _class_EditorFileDialog_signal_files_selected: - **files_selected** **(** :ref:`PoolStringArray` paths **)** Emitted when multiple files are selected. Enumerations ------------ .. _enum_EditorFileDialog_Mode: .. _class_EditorFileDialog_constant_MODE_OPEN_FILE: .. _class_EditorFileDialog_constant_MODE_OPEN_FILES: .. _class_EditorFileDialog_constant_MODE_OPEN_DIR: .. _class_EditorFileDialog_constant_MODE_OPEN_ANY: .. _class_EditorFileDialog_constant_MODE_SAVE_FILE: enum **Mode**: - **MODE_OPEN_FILE** = **0** --- The ``EditorFileDialog`` can select only one file. Accepting the window will open the file. - **MODE_OPEN_FILES** = **1** --- The ``EditorFileDialog`` can select multiple files. Accepting the window will open all files. - **MODE_OPEN_DIR** = **2** --- The ``EditorFileDialog`` can select only one directory. Accepting the window will open the directory. - **MODE_OPEN_ANY** = **3** --- The ``EditorFileDialog`` can select a file or directory. Accepting the window will open it. - **MODE_SAVE_FILE** = **4** --- The ``EditorFileDialog`` can select only one file. Accepting the window will save the file. ---- .. _enum_EditorFileDialog_Access: .. _class_EditorFileDialog_constant_ACCESS_RESOURCES: .. _class_EditorFileDialog_constant_ACCESS_USERDATA: .. _class_EditorFileDialog_constant_ACCESS_FILESYSTEM: enum **Access**: - **ACCESS_RESOURCES** = **0** --- The ``EditorFileDialog`` can only view ``res://`` directory contents. - **ACCESS_USERDATA** = **1** --- The ``EditorFileDialog`` can only view ``user://`` directory contents. - **ACCESS_FILESYSTEM** = **2** --- The ``EditorFileDialog`` can view the entire local file system. ---- .. _enum_EditorFileDialog_DisplayMode: .. _class_EditorFileDialog_constant_DISPLAY_THUMBNAILS: .. _class_EditorFileDialog_constant_DISPLAY_LIST: enum **DisplayMode**: - **DISPLAY_THUMBNAILS** = **0** --- The ``EditorFileDialog`` displays resources as thumbnails. - **DISPLAY_LIST** = **1** --- The ``EditorFileDialog`` displays resources as a list of filenames. Property Descriptions --------------------- .. _class_EditorFileDialog_property_access: - :ref:`Access` **access** +-----------+-------------------+ | *Default* | ``0`` | +-----------+-------------------+ | *Setter* | set_access(value) | +-----------+-------------------+ | *Getter* | get_access() | +-----------+-------------------+ The location from which the user may select a file, including ``res://``, ``user://``, and the local file system. ---- .. _class_EditorFileDialog_property_current_dir: - :ref:`String` **current_dir** +-----------+------------------------+ | *Default* | ``"res://"`` | +-----------+------------------------+ | *Setter* | set_current_dir(value) | +-----------+------------------------+ | *Getter* | get_current_dir() | +-----------+------------------------+ The currently occupied directory. ---- .. _class_EditorFileDialog_property_current_file: - :ref:`String` **current_file** +-----------+-------------------------+ | *Default* | ``""`` | +-----------+-------------------------+ | *Setter* | set_current_file(value) | +-----------+-------------------------+ | *Getter* | get_current_file() | +-----------+-------------------------+ The currently selected file. ---- .. _class_EditorFileDialog_property_current_path: - :ref:`String` **current_path** +-----------+-------------------------+ | *Default* | ``"res://"`` | +-----------+-------------------------+ | *Setter* | set_current_path(value) | +-----------+-------------------------+ | *Getter* | get_current_path() | +-----------+-------------------------+ The file system path in the address bar. ---- .. _class_EditorFileDialog_property_disable_overwrite_warning: - :ref:`bool` **disable_overwrite_warning** +-----------+--------------------------------------+ | *Default* | ``false`` | +-----------+--------------------------------------+ | *Setter* | set_disable_overwrite_warning(value) | +-----------+--------------------------------------+ | *Getter* | is_overwrite_warning_disabled() | +-----------+--------------------------------------+ If ``true``, the ``EditorFileDialog`` will not warn the user before overwriting files. ---- .. _class_EditorFileDialog_property_display_mode: - :ref:`DisplayMode` **display_mode** +-----------+-------------------------+ | *Default* | ``0`` | +-----------+-------------------------+ | *Setter* | set_display_mode(value) | +-----------+-------------------------+ | *Getter* | get_display_mode() | +-----------+-------------------------+ The view format in which the ``EditorFileDialog`` displays resources to the user. ---- .. _class_EditorFileDialog_property_mode: - :ref:`Mode` **mode** +-----------+-----------------+ | *Default* | ``4`` | +-----------+-----------------+ | *Setter* | set_mode(value) | +-----------+-----------------+ | *Getter* | get_mode() | +-----------+-----------------+ The purpose of the ``EditorFileDialog``, which defines the allowed behaviors. ---- .. _class_EditorFileDialog_property_show_hidden_files: - :ref:`bool` **show_hidden_files** +-----------+------------------------------+ | *Default* | ``false`` | +-----------+------------------------------+ | *Setter* | set_show_hidden_files(value) | +-----------+------------------------------+ | *Getter* | is_showing_hidden_files() | +-----------+------------------------------+ If ``true``, hidden files and directories will be visible in the ``EditorFileDialog``. Method Descriptions ------------------- .. _class_EditorFileDialog_method_add_filter: - void **add_filter** **(** :ref:`String` filter **)** Adds a comma-delimited file extension filter option to the ``EditorFileDialog`` with an optional semi-colon-delimited label. For example, ``"*.tscn, *.scn; Scenes"`` results in filter text "Scenes (\*.tscn, \*.scn)". ---- .. _class_EditorFileDialog_method_clear_filters: - void **clear_filters** **(** **)** Removes all filters except for "All Files (\*)". ---- .. _class_EditorFileDialog_method_get_vbox: - :ref:`VBoxContainer` **get_vbox** **(** **)** Returns the ``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. ---- .. _class_EditorFileDialog_method_invalidate: - void **invalidate** **(** **)** Notify the ``EditorFileDialog`` that its view of the data is no longer accurate. Updates the view contents on next view update. .. |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.)`