Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

FileDialog¶

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

A 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. 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)
bool	use_native_dialog	`false`

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¶

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.

files_selected ( PackedStringArray paths )

Emitted when the user selects multiple files.

Enumerations¶

enum FileMode:

FileMode FILE_MODE_OPEN_FILE = 0

The dialog allows selecting one, and only one file.

FileMode FILE_MODE_OPEN_FILES = 1

The dialog allows selecting multiple files.

FileMode FILE_MODE_OPEN_DIR = 2

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

FileMode FILE_MODE_OPEN_ANY = 3

The dialog allows selecting one file or directory.

FileMode FILE_MODE_SAVE_FILE = 4

The dialog will warn when a file exists.

enum Access:

Access ACCESS_RESOURCES = 0

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

Access ACCESS_USERDATA = 1

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

Access ACCESS_FILESYSTEM = 2

The dialog allows accessing files on the whole file system.

Property Descriptions¶

Access access = 0

void set_access ( Access value )
Access get_access ( )

The file system access scope. See 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.

String current_dir

void set_current_dir ( String value )
String get_current_dir ( )

The current working directory of the file dialog.

String current_file

void set_current_file ( String value )
String get_current_file ( )

The currently selected file of the file dialog.

String current_path

void set_current_path ( String value )
String get_current_path ( )

The currently selected file path of the file dialog.

FileMode file_mode = 4

void set_file_mode ( FileMode value )
FileMode get_file_mode ( )

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

PackedStringArray filters = PackedStringArray()

void set_filters ( PackedStringArray value )
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.

bool mode_overrides_title = true

void set_mode_overrides_title ( bool value )
bool is_mode_overriding_title ( )

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").

String root_subfolder = ""

void set_root_subfolder ( String value )
String 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 = false

void set_show_hidden_files ( bool value )
bool is_showing_hidden_files ( )

If true, the dialog will show hidden files.

bool use_native_dialog = false

void set_use_native_dialog ( bool value )
bool get_use_native_dialog ( )

If true, access is set to ACCESS_FILESYSTEM, and it is supported by the current DisplayServer, OS native dialog will be used instead of custom one.

Note: On macOS, sandboxed apps always use native dialogs to access host filesystem.

Method Descriptions¶

void add_filter ( String fi