class_editorfiledialog.rst

github_url:	hide

EditorFileDialog

Inherits: :ref:`ConfirmationDialog<class_ConfirmationDialog>` < :ref:`AcceptDialog<class_AcceptDialog>` < :ref:`WindowDialog<class_WindowDialog>` < :ref:`Popup<class_Popup>` < :ref:`Control<class_Control>` < :ref:`CanvasItem<class_CanvasItem>` < :ref:`Node<class_Node>` < :ref:`Object<class_Object>`

A modified version of :ref:`FileDialog<class_FileDialog>` used by the editor.

Properties

:ref:`Access<enum_EditorFileDialog_Access>`	:ref:`access<class_EditorFileDialog_property_access>`	0
:ref:`String<class_String>`	:ref:`current_dir<class_EditorFileDialog_property_current_dir>`	"res://"
:ref:`String<class_String>`	:ref:`current_file<class_EditorFileDialog_property_current_file>`	""
:ref:`String<class_String>`	:ref:`current_path<class_EditorFileDialog_property_current_path>`	"res://"
:ref:`bool<class_bool>`	dialog_hide_on_ok	O: false
:ref:`bool<class_bool>`	:ref:`disable_overwrite_warning<class_EditorFileDialog_property_disable_overwrite_warning>`	false
:ref:`DisplayMode<enum_EditorFileDialog_DisplayMode>`	:ref:`display_mode<class_EditorFileDialog_property_display_mode>`	0
:ref:`Mode<enum_EditorFileDialog_Mode>`	:ref:`mode<class_EditorFileDialog_property_mode>`	4
:ref:`bool<class_bool>`	resizable	O: true
:ref:`bool<class_bool>`	:ref:`show_hidden_files<class_EditorFileDialog_property_show_hidden_files>`	false
:ref:`String<class_String>`	window_title	O: "Save a File"

Methods

void	:ref:`add_filter<class_EditorFileDialog_method_add_filter>` ( :ref:`String<class_String>` filter )
void	:ref:`clear_filters<class_EditorFileDialog_method_clear_filters>` ( )
:ref:`VBoxContainer<class_VBoxContainer>`	:ref:`get_vbox<class_EditorFileDialog_method_get_vbox>` ( )
void	:ref:`invalidate<class_EditorFileDialog_method_invalidate>` ( )

Signals

• dir_selected ( :ref:`String<class_String>` dir )

Emitted when a directory is selected.

---

• file_selected ( :ref:`String<class_String>` path )

Emitted when a file is selected.

---

• files_selected ( :ref:`PackedStringArray<class_PackedStringArray>` paths )

Emitted when multiple files are selected.

Enumerations

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 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 DisplayMode:

• DISPLAY_THUMBNAILS = 0 --- The EditorFileDialog displays resources as thumbnails.
• DISPLAY_LIST = 1 --- The EditorFileDialog displays resources as a list of filenames.

Property Descriptions

• :ref:`Access<enum_EditorFileDialog_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.

---

• :ref:`String<class_String>` current_dir

Default	"res://"
Setter	set_current_dir(value)
Getter	get_current_dir()

The currently occupied directory.

---

• :ref:`String<class_String>` current_file

Default	""
Setter	set_current_file(value)
Getter	get_current_file()

The currently selected file.

---

• :ref:`String<class_String>` current_path

Default	"res://"
Setter	set_current_path(value)
Getter	get_current_path()

The file system path in the address bar.

---

• :ref:`bool<class_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.

---

• :ref:`DisplayMode<enum_EditorFileDialog_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.

---

• :ref:`Mode<enum_EditorFileDialog_Mode>` mode

Default	4
Setter	set_mode(value)
Getter	get_mode()

The purpose of the EditorFileDialog, which defines the allowed behaviors.

---

• :ref:`bool<class_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

• void add_filter ( :ref:`String<class_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)".

---

• void clear_filters ( )

Removes all filters except for "All Files (*)".

---

• :ref:`VBoxContainer<class_VBoxContainer>` get_vbox ( )

Returns the VBoxContainer used to display the file system.

---

• void invalidate ( )

Notify the EditorFileDialog that its view of the data is no longer accurate. Updates the view contents on next view update.