Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
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¶
|
||
dialog_hide_on_ok |
|
|
|
||
|
||
|
||
|
||
|
||
title |
|
|
|
Methods¶
void |
add_filter ( String filter, String description="" ) |
void |
clear_filters ( ) |
void |
deselect_all ( ) |
get_line_edit ( ) |
|
get_vbox ( ) |
|
void |
invalidate ( ) |
Theme Properties¶
|
||
|
||
|
||
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://
).