class-description NEWS COMMUNITY STORE TUTORIALS SIGN UP LOGIN LOGOUT ROKOJORI NEWSLETTER SIGN UP LOGIN LOGOUT NEWS COMMUNITY STORE TUTORIALS TOGGLE FULLSCREEN VOLLBILD AN/AUS ObjectNodeViewportWindowAcceptDialogConfirmationDialog FileDialog
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.

 dir_selected dir_selected<>( String dir=, dir:String=, ):dir_selected

Emitted when the user selects a directory.

 file_selected file_selected<>( String path=, path:String=, ):file_selected

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

 files_selected files_selected<>( PackedStringArray paths=, paths:PackedStringArray=, ):files_selected

Emitted when the user selects multiple files.

 Enum FileMode<>():Enum

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<>():Enum

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.

 Access access<>():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<>():String

The current working directory of the file dialog.

 String current_file<>():String

The currently selected file of the file dialog.

 String current_path<>():String

The currently selected file path of the file dialog.

 FileMode file_mode<>():FileMode

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

 PackedStringArray filters<>():PackedStringArray

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<>():bool

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<>():int

The number of additional OptionButtons and CheckBoxes in the dialog.

 String root_subfolder<>():String

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<>():bool

If true, the dialog will show hidden files.

 bool use_native_dialog<>():bool

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.

 void add_filter<>( String filter=, filter:String=, String description="", description:String="", ):void

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 add_option<>( String name=, name:String=, PackedStringArray values=, values:PackedStringArray=, int index=, index:int=, ):void

Adds an additional OptionButton to the file dialog. If values is empty, a CheckBox is added instead.

 void clear_filters<>():void

Clear all the added filters in the dialog.

 void deselect_all<>():void

Clear all currently selected items in the dialog.

 LineEdit get_line_edit<>():LineEdit

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=, option:int=, ):int

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

 String get_option_name<>( int option=, option:int=, ):String

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

 PackedStringArray get_option_values<>( int option=, option:int=, ):PackedStringArray

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

 Dictionary get_selected_options<>():Dictionary

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<>():VBoxContainer

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<>():void

Invalidate and update the current dialog content list.

 void set_option_default<>( int option=, option:int=, int index=, index:int=, ):void

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

 void set_option_name<>( int option=, option:int=, String name=, name:String=, ):void

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

 void set_option_values<>( int option=, option:int=, PackedStringArray values=, values:PackedStringArray=, ):void

Sets the option values of the OptionButton with index option.


All social media brands are registrated trademarks and belong to their respective owners.





CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com We are using cookies on this site. Read more... Wir benutzen Cookies auf dieser Seite. Mehr lesen...