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.
描述¶
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
.
属性¶
|
||
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¶
|
||
|
||
|
||
信号¶
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
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
The current working directory of the file dialog.
String current_file
The currently selected file of the file dialog.
String current_path
The currently selected file path of the file dialog.
FileMode file_mode = 4
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
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 = ""
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.
If true
, the dialog will show hidden files.
bool use_native_dialog = false
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 filter, String description="" )
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&q