FileDialog

int access = 0

The file system access scope. Warning: In Web builds, FileDialog cannot access the host file system. In sandboxed Linux and macOS environments, use_native_dialog is automatically used to allow limited access to host file system.

String current_dir

The current working directory of the file dialog. Note: For native file dialogs, this property is only treated as a hint and may not be respected by specific OS implementations.

String current_file

The currently selected file of the file dialog.

String current_path

The currently selected file path of the file dialog.

bool dialog_hide_on_ok = false

int display_mode = 0

Display mode of the dialog's file list.

bool favorites_enabled = true

If true, shows the toggle favorite button and favorite list on the left side of the dialog.

bool file_filter_toggle_enabled = true

If true, shows the toggle file filter button.

int file_mode = 4

The dialog's open or save mode, which affects the selection behavior.

bool file_sort_options_enabled = true

If true, shows the file sorting options button.

String filename_filter = ""

The filter for file names (case-insensitive). When set to a non-empty string, only files that contains the substring will be shown. filename_filter can be edited by the user with the filter button at the top of the file dialog. See also filters, which should be used to restrict the file types that can be selected instead of filename_filter which is meant to be set by the user.

PackedStringArray filters = PackedStringArray()

The available file type filters. Each filter string in the array should be formatted like this: *.png,*.jpg,*.jpeg;Image Files;image/png,image/jpeg. The description text of the filter is optional and can be omitted. Both file extensions and MIME type should be always set. Note: Embedded file dialog and Windows file dialog support only file extensions, while Android, Linux, and macOS file dialogs also support MIME types.

bool folder_creation_enabled = true

If true, shows the button for creating new directories (when using FILE_MODE_OPEN_DIR, FILE_MODE_OPEN_ANY, or FILE_MODE_SAVE_FILE).

bool hidden_files_toggle_enabled = true

If true, shows the toggle hidden files button.

bool layout_toggle_enabled = true

If true, shows the layout switch buttons (list/thumbnails).

bool mode_overrides_title = true

If true, changing the file_mode property will set the window title accordingly (e.g. setting file_mode to FILE_MODE_OPEN_FILE will change the window title to "Open a File").

int option_count = 0

The number of additional OptionButtons and CheckBoxes in the dialog.

bool recent_list_enabled = true

If true, shows the recent directories list on the left side of the dialog.

String 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. Note: This property is ignored by native file dialogs.

bool show_hidden_files = false

If true, the dialog will show hidden files. Note: This property is ignored by native file dialogs on Android and Linux.

Vector2i size = Vector2i(640, 360)

String title = "Save a File"

bool use_native_dialog = false

If true, and if supported by the current DisplayServer, OS native dialog will be used instead of custom one. Note: On Android, it is only supported for Android 10+ devices and when using ACCESS_FILESYSTEM. For access mode ACCESS_RESOURCES and ACCESS_USERDATA, the system will fall back to custom FileDialog. Note: On Linux and macOS, sandboxed apps always use native dialogs to access the host file system. Note: On macOS, sandboxed apps will save security-scoped bookmarks to retain access to the opened folders across multiple sessions. Use OS.get_granted_permissions() to get a list of saved bookmarks. Note: Native dialogs are isolated from the base process, file dialog properties can't be modified once the dialog is shown.

void add_filter(String filter, String description = "")

Adds a comma-separated file name filter option to the FileDialog 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 "*.png, *.jpg" and a description of "Images" results in filter text "Images (*.png, *.jpg)".

void add_option(String name, PackedStringArray values, int default_value_index)

Adds an additional OptionButton to the file dialog. If values is empty, a 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).

void clear_filename_filter()

Clear the filter for file names.

void clear_filters()

Clear all the added filters in the dialog.

void deselect_all()

Clear all currently selected items in the dialog.

LineEdit get_line_edit()

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 CanvasItem.visible property.

int get_option_default(int option) const

Returns the default value index of the OptionButton or CheckBox with index option.

String get_option_name(int option) const

Returns the name of the OptionButton or CheckBox with index option.

PackedStringArray get_option_values(int option) const

Returns an array of values of the OptionButton with index option.

Dictionary get_selected_options() const

Returns a Dictionary with the selected values of the additional OptionButtons and/or CheckBoxes. Dictionary keys are names and values are selected value indices.

VBoxContainer get_vbox()

Returns the vertical box container of the dialog, custom controls can be added to it. 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 CanvasItem.visible property. Note: Changes to this node are ignored by native file dialogs, use add_option() to add custom elements to the dialog instead.

void invalidate()

Invalidate and update the current dialog content list. Note: This method does nothing on native file dialogs.

bool is_customization_flag_enabled(int flag) const

Returns true if the provided flag is enabled.

void set_customization_flag_enabled(int flag, bool enabled)

Toggles the specified customization flag, allowing to customize features available in this FileDialog. See Customization for options.

void set_option_default(int option, int default_value_index)

Sets the default value index of the OptionButton or CheckBox with index option.

void set_option_name(int option, String name)

Sets the name of the OptionButton or CheckBox with index option.

void set_option_values(int option, PackedStringArray values)

Sets the option values of the OptionButton with index option.

dir_selected(String dir)

Emitted when the user selects a directory.

file_selected(String path)

Emitted when the user selects a file by double-clicking it or pressing the OK button.

filename_filter_changed(String filter)

Emitted when the filter for file names changes.

files_selected(PackedStringArray paths)

Emitted when the user selects multiple files.

FILE_MODE_OPEN_FILE = 0

Enum: FileMode

The dialog allows selecting one, and only one file.

FILE_MODE_OPEN_FILES = 1

Enum: FileMode

The dialog allows selecting multiple files.

FILE_MODE_OPEN_DIR = 2

Enum: FileMode

The dialog only allows selecting a directory, disallowing the selection of any file.

FILE_MODE_OPEN_ANY = 3

Enum: FileMode

The dialog allows selecting one file or directory.

FILE_MODE_SAVE_FILE = 4

Enum: FileMode

The dialog will warn when a file exists.

ACCESS_RESOURCES = 0

Enum: Access

The dialog only allows accessing files under the Resource path (res://).

ACCESS_USERDATA = 1

Enum: Access

The dialog only allows accessing files under user data path (user://).

ACCESS_FILESYSTEM = 2

Enum: Access

The dialog allows accessing files on the whole file system.

DISPLAY_THUMBNAILS = 0

Enum: DisplayMode

The dialog displays files as a grid of thumbnails. Use thumbnail_size to adjust their size.

DISPLAY_LIST = 1

Enum: DisplayMode

The dialog displays files as a list of filenames.

CUSTOMIZATION_HIDDEN_FILES = 0

Enum: Customization

Toggles visibility of the favorite button, and the favorite list on the left side of the dialog. Equivalent to hidden_files_toggle_enabled.

CUSTOMIZATION_CREATE_FOLDER = 1

Enum: Customization

If enabled, shows the button for creating new directories (when using FILE_MODE_OPEN_DIR, FILE_MODE_OPEN_ANY, or FILE_MODE_SAVE_FILE). Equivalent to folder_creation_enabled.

CUSTOMIZATION_FILE_FILTER = 2

Enum: Customization

If enabled, shows the toggle file filter button. Equivalent to file_filter_toggle_enabled.

CUSTOMIZATION_FILE_SORT = 3

Enum: Customization

If enabled, shows the file sorting options button. Equivalent to file_sort_options_enabled.

CUSTOMIZATION_FAVORITES = 4

Enum: Customization

If enabled, shows the toggle favorite button and favorite list on the left side of the dialog. Equivalent to favorites_enabled.

CUSTOMIZATION_RECENT = 5

Enum: Customization

If enabled, shows the recent directories list on the left side of the dialog. Equivalent to recent_list_enabled.

CUSTOMIZATION_LAYOUT = 6

Enum: Customization

If enabled, shows the layout switch buttons (list/thumbnails). Equivalent to layout_toggle_enabled.

Color file_disabled_color = Color(1, 1, 1, 0.25)

The color tint for disabled files (when the FileDialog is used in open folder mode).

Color file_icon_color = Color(1, 1, 1, 1)

The color modulation applied to the file icon.

Color folder_icon_color = Color(1, 1, 1, 1)

The color modulation applied to the folder icon.

int thumbnail_size = 64

The size of thumbnail icons when DISPLAY_THUMBNAILS is enabled.

Texture2D back_folder

Custom icon for the back arrow.

Texture2D create_folder

Custom icon for the create folder button.

Texture2D favorite

Custom icon for favorite folder button.

Texture2D favorite_down

Custom icon for button to move down a favorite entry.

Texture2D favorite_up

Custom icon for button to move up a favorite entry.

Texture2D file

Custom icon for files.

Texture2D file_thumbnail

Icon for files when in thumbnail mode.

Texture2D folder

Custom icon for folders.

Texture2D folder_thumbnail

Icon for folders when in thumbnail mode.

Texture2D forward_folder

Custom icon for the forward arrow.

Texture2D list_mode

Icon for the button that enables list mode.

Texture2D parent_folder

Custom icon for the parent folder arrow.

Texture2D reload

Custom icon for the reload button.

Texture2D sort

Custom icon for the sorting options menu.

Texture2D thumbnail_mode

Icon for the button that enables thumbnail mode.

Texture2D toggle_filename_filter

Custom icon for the toggle button for the filter for file names.

Texture2D toggle_hidden

Custom icon for the toggle hidden button.