FileDialog

Inherits: ConfirmationDialog < AcceptDialog < Window < Viewport < Node < Object

Dialog for selecting files or directories in the filesystem.

Description

FileDialog is a preset dialog used to choose files and directories in the filesystem. It supports filter masks. The FileDialog automatically sets its window title according to the file_mode. If you want to use a custom title, disable this by setting mode_overrides_title to false.

Properties

Access

access

0

String

current_dir

String

current_file

String

current_path

bool

dialog_hide_on_ok

false (overrides AcceptDialog)

FileMode

file_mode

4

PackedStringArray

filters

PackedStringArray()

bool

mode_overrides_title

true

String

root_subfolder

""

bool

show_hidden_files

false

String

title

"Save a File" (overrides Window)

Methods

void

add_filter ( String filter, String description="" )

void

clear_filters ( )

void

deselect_all ( )

LineEdit

get_line_edit ( )

VBoxContainer

get_vbox ( )

void

invalidate ( )

Theme Properties

Color

file_disabled_color

Color(1, 1, 1, 0.25)

Color

file_icon_color

Color(1, 1, 1, 1)

Color

folder_icon_color

Color(1, 1, 1, 1)

Texture2D

back_folder

Texture2D

file

Texture2D

folder

Texture2D

forward_folder

Texture2D

parent_folder

Texture2D

reload

Texture2D

toggle_hidden

Signals

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.

Emitted when the user selects multiple files.

Enumerations

enum FileMode:

  • FILE_MODE_OPEN_FILE = 0 --- The dialog allows selecting one, and only one file.

  • FILE_MODE_OPEN_FILES = 1 --- The dialog allows selecting multiple files.

  • FILE_MODE_OPEN_DIR = 2 --- The dialog only allows selecting a directory, disallowing the selection of any file.

  • FILE_MODE_OPEN_ANY = 3 --- The dialog allows selecting one file or directory.

  • FILE_MODE_SAVE_FILE = 4 --- The dialog will warn when a file exists.

enum Access:

  • ACCESS_RESOURCES = 0 --- The dialog only allows accessing files under the Resource path (res://).

  • ACCESS_USERDATA = 1 --- The dialog only allows accessing files under user data path (user://).

  • ACCESS_FILESYSTEM = 2 --- The dialog allows accessing files on the whole file system.

Property Descriptions

Default

0

Setter

set_access(value)

Getter

get_access()

The file system access scope. See enum Access constants.

Warning: Currently, in sandboxed environments such as Web builds or sandboxed macOS apps, FileDialog cannot access the host file system. See godot-proposals#1123.

Setter

set_current_dir(value)

Getter

get_current_dir()

The current working directory of the file dialog.

Setter

set_current_file(value)

Getter

get_current_file()

The currently selected file of the file dialog.

Setter

set_current_path(value)

Getter

get_current_path()

The currently selected file path of the file dialog.

Default

4

Setter

set_file_mode(value)

Getter

get_file_mode()

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

Default

PackedStringArray()

Setter

set_filters(value)

Getter

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.

  • bool mode_overrides_title

Default

true

Setter

set_mode_overrides_title(value)

Getter

is_mode_overriding_title()

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

Default

""

Setter

set_root_subfolder(value)

Getter

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.

  • bool show_hidden_files

Default

false

Setter

set_show_hidden_files(value)

Getter

is_showing_hidden_files()

If true, the dialog will show hidden files.

Method Descriptions

Adds a comma-delimited 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 clear_filters ( )

Clear all the added filters in the dialog.

  • void deselect_all ( )

Clear all currently selected items in the dialog.

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.

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.

  • void invalidate ( )

Invalidate and update the current dialog content list.

Theme Property Descriptions

  • Color file_disabled_color

Default

Color(1, 1, 1, 0.25)

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

Default

Color(1, 1, 1, 1)

The color modulation applied to the file icon.

  • Color folder_icon_color

Default

Color(1, 1, 1, 1)

The color modulation applied to the folder icon.

Custom icon for the back arrow.

Custom icon for files.

Custom icon for folders.

Custom icon for the forward arrow.

Custom icon for the parent folder arrow.

Custom icon for the reload button.

Custom icon for the toggle hidden button.