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.
Note: FileDialog is invisible by default. To make it visible, call one of the popup_* methods from Window on the node, such as [method Window.popup_centered_clamped].
 Enum FileMode<>():Enum

FILE_MODE_OPEN_FILE:null = 0
The dialog allows selecting one, and only one file.


FILE_MODE_OPEN_FILES:null = 1
The dialog allows selecting multiple files.


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


FILE_MODE_OPEN_ANY:null = 3
The dialog allows selecting one file or directory.


FILE_MODE_SAVE_FILE:null = 4
The dialog will warn when a file exists.
 Enum Access<>():Enum

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


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


ACCESS_FILESYSTEM:null = 2
The dialog allows accessing files on the whole file system.
 Enum DisplayMode<>():Enum

DISPLAY_THUMBNAILS:null = 0
The dialog displays files as a grid of thumbnails. Use thumbnail_size to adjust their size.


DISPLAY_LIST:null = 1
The dialog displays files as a list of filenames.
 Enum Customization<>():Enum

CUSTOMIZATION_HIDDEN_FILES:null = 0
Toggles visibility of the favorite button, and the favorite list on the left side of the dialog.
Equivalent to hidden_files_toggle_enabled.


CUSTOMIZATION_CREATE_FOLDER:null = 1
If enabled, shows the button for creating new directories (when using FILE_MODE_OPEN_DIR, FILE_MODE_OPEN_ANY, or FILE_MODE_SAVE_FILE).
Equivalent to folder_creation_enabled.


CUSTOMIZATION_FILE_FILTER:null = 2
If enabled, shows the toggle file filter button.
Equivalent to file_filter_toggle_enabled.


CUSTOMIZATION_FILE_SORT:null = 3
If enabled, shows the file sorting options button.
Equivalent to file_sort_options_enabled.


CUSTOMIZATION_FAVORITES:null = 4
If enabled, shows the toggle favorite button and favorite list on the left side of the dialog.
Equivalent to favorites_enabled.


CUSTOMIZATION_RECENT:null = 5
If enabled, shows the recent directories list on the left side of the dialog.
Equivalent to recent_list_enabled.


CUSTOMIZATION_LAYOUT:null = 6
If enabled, shows the layout switch buttons (list/thumbnails).
Equivalent to layout_toggle_enabled.


CUSTOMIZATION_OVERWRITE_WARNING:null = 7
If enabled, the FileDialog will warn the user before overwriting files in save mode.
Equivalent to overwrite_warning_enabled.


CUSTOMIZATION_DELETE:null = 8
If enabled, the context menu will show the "Delete" option, which allows moving files and folders to trash.
Equivalent to deleting_enabled.
 Signal dir_selected<>( String dir=, dir:String=, ):Signal
Emitted when the user selects a directory.

Signal file_selected<>( String path=, path:String=, ):Signal
Emitted when the user selects a file by double-clicking it or pressing the OK button.

Signal filename_filter_changed<>( String filter=, filter:String=, ):Signal
Emitted when the filter for file names changes.

Signal files_selected<>( PackedStringArray paths=, paths:PackedStringArray=, ):Signal
Emitted when the user selects multiple files.

set get int access<>():int set get
The file system access scope.

Warning: In Web builds, FileDialog cannot access the host file system. In sandboxed Linux and macOS environments, use_native_dialog is automatically used to allow limited access to host file system.
 set get String current_dir<>():String set get
The current working directory of the file dialog.

Note: For native file dialogs, this property is only treated as a hint and may not be respected by specific OS implementations.
 set get String current_file<>():String set get
The currently selected file of the file dialog.

set get String current_path<>():String set get
The currently selected file path of the file dialog.

set get bool deleting_enabled<>():bool set get
If true, the context menu will show the "Delete" option, which allows moving files and folders to trash.

set get bool dialog_hide_on_ok<>():bool set get
set get int display_mode<>():int set get
Display mode of the dialog's file list.

set get bool favorites_enabled<>():bool set get
If true, shows the toggle favorite button and favorite list on the left side of the dialog.

set get bool file_filter_toggle_enabled<>():bool set get
If true, shows the toggle file filter button.

set get int file_mode<>():int set get
The dialog's open or save mode, which affects the selection behavior.

set get bool file_sort_options_enabled<>():bool set get
If true, shows the file sorting options button.

set get String filename_filter<>():String set get
The filter for file names (case-insensitive). When set to a non-empty string, only files that contains the substring will be shown. filename_filter can be edited by the user with the filter button at the top of the file dialog.

See also filters, which should be used to restrict the file types that can be selected instead of filename_filter which is meant to be set by the user.
 set get PackedStringArray filters<>():PackedStringArray set get
The available file type filters. Each filter string in the array should be formatted like this: *.png,*.jpg,*.jpeg;Image Files;image/png,image/jpeg. The description text of the filter is optional and can be omitted. Both file extensions and MIME type should be always set.

Note: Embedded file dialogs and Windows file dialogs support only file extensions, while Android, Linux, and macOS file dialogs also support MIME types.
 set get bool folder_creation_enabled<>():bool set get
If true, shows the button for creating new directories (when using FILE_MODE_OPEN_DIR, FILE_MODE_OPEN_ANY, or FILE_MODE_SAVE_FILE), and the context menu will have the "New Folder..." option.

set get bool hidden_files_toggle_enabled<>():bool set get
If true, shows the toggle hidden files button.

set get bool layout_toggle_enabled<>():bool set get
If true, shows the layout switch buttons (list/thumbnails).

set get bool mode_overrides_title<>():bool set get
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").

set get int option_count<>():int set get
The number of additional OptionButtons and CheckBoxes in the dialog.

set get int option_{index}/default<>():int set get
The default value for the option at index.

Note: index is a value in the 0 .. option_count - 1 range.
 set get String option_{index}/name<>():String set get
The name of the option at index.

Note: index is a value in the 0 .. option_count - 1 range.
 set get PackedStringArray option_{index}/values<>():PackedStringArray set get
The list of values for the option at index.

Note: index is a value in the 0 .. option_count - 1 range.
 set get bool overwrite_warning_enabled<>():bool set get
If true, the FileDialog will warn the user before overwriting files in save mode.

set get bool recent_list_enabled<>():bool set get
If true, shows the recent directories list on the left side of the dialog.

set get String root_subfolder<>():String set get
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.

Note: This property is ignored by native file dialogs.
 set get bool show_hidden_files<>():bool set get
If true, the dialog will show hidden files.

Note: This property is ignored by native file dialogs on Android and Linux.
 set get Vector2i size<>():Vector2i set get
set get String title<>():String set get
set get bool use_native_dialog<>():bool set get
If true, and if supported by the current DisplayServer, OS native dialog will be used instead of custom one.

Note: On Android, it is only supported when using ACCESS_FILESYSTEM. For access mode ACCESS_RESOURCES and ACCESS_USERDATA, the system will fall back to custom FileDialog.
Note: On Linux and macOS, sandboxed apps always use native dialogs to access the host file system.
Note: On macOS, sandboxed apps will save security-scoped bookmarks to retain access to the opened folders across multiple sessions. Use [method OS.get_granted_permissions] to get a list of saved bookmarks.
Note: Native dialogs are isolated from the base process, file dialog properties can't be modified once the dialog is shown.
Note: This property is ignored in EditorFileDialog.
 void add_filter<>( String filter=, filter:String=, String description="", description:String="", String mime_type="", mime_type:String="", ):void
Adds a comma-separated file extension filter and comma-separated MIME type mime_type 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", a mime_type of image/png, image/jpeg, and a description of "Images" results in filter text "Images (*.png, *.jpg)".
Note: Embedded file dialogs and Windows file dialogs support only file extensions, while Android, Linux, and macOS file dialogs also support MIME types.
 void add_option<>( String name=, name:String=, PackedStringArray values=, values:PackedStringArray=, int default_value_index=, default_value_index:int=, ):void
Adds an additional OptionButton to the file dialog. If values is empty, a CheckBox is added instead.

default_value_index should be an index of the value in the values. If values is empty it should be either 1 (checked), or 0 (unchecked).
 void clear_filename_filter<>():void
Clear the filter for file names.

void clear_filters<>():void
Clear all the added filters in the dialog.

void deselect_all<>():void
Clear all currently selected items in the dialog.

PackedStringArray get_favorite_list<>():PackedStringArray
Returns the list of favorite directories, which is shared by all FileDialog nodes. Useful to store the list of favorites between project sessions. This method can be called only from the main thread.

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 [member 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.

PackedStringArray get_recent_list<>():PackedStringArray
Returns the list of recent directories, which is shared by all FileDialog nodes. Useful to store the list of recents between project sessions. This method can be called only from the main thread.

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 [member CanvasItem.visible] property.
Note: Changes to this node are ignored by native file dialogs, use add_option to add custom elements to the dialog instead.
 void invalidate<>():void
Invalidates and updates this dialog's content list.

Note: This method does nothing on native file dialogs.
 bool is_customization_flag_enabled<>( int flag=, flag:int=, ):bool
Returns true if the provided flag is enabled.

void popup_file_dialog<>():void
Shows the FileDialog using the default size and position for file dialogs, and selects the file name if there is a current file.

void set_customization_flag_enabled<>( int flag=, flag:int=, bool enabled=, enabled:bool=, ):void
Sets the specified customization flag, allowing to customize the features available in this FileDialog.

void set_favorite_list<>( PackedStringArray favorites=, favorites:PackedStringArray=, ):void
Sets the list of favorite directories, which is shared by all FileDialog nodes. Useful to restore the list of favorites saved with get_favorite_list. This method can be called only from the main thread.

Note: FileDialog will update its internal ItemList of favorites when its visibility changes. Be sure to call this method earlier if you want your changes to have effect.
 void set_get_icon_callback<>( Callable callback=, callback:Callable=, ):void
Sets the callback used by the FileDialog nodes to get a file icon, when DISPLAY_LIST mode is used. The callback should take a single String argument (file path), and return a Texture2D. If an invalid texture is returned, the file icon will be used instead.

void set_get_thumbnail_callback<>( Callable callback=, callback:Callable=, ):void
Sets the callback used by the FileDialog nodes to get a file icon, when DISPLAY_THUMBNAILS mode is used. The callback should take a single String argument (file path), and return a Texture2D. If an invalid texture is returned, the file_thumbnail icon will be used instead.

Thumbnails are usually more complex and may take a while to load. To avoid stalling the application, you can use ImageTexture to asynchronously create the thumbnail.
func _ready(): FileDialog.set_get_thumbnail_callback(thumbnail_method) func thumbnail_method(path): var image_texture = ImageTexture.new() make_thumbnail_async(path, image_texture) return image_texture func make_thumbnail_async(path, image_texture): var thumbnail_texture = await generate_thumbnail(path) # Some method that generates a thumbnail. image_texture.set_image(thumbnail_texture.get_image())
void set_option_default<>( int option=, option:int=, int default_value_index=, default_value_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.

void set_recent_list<>( PackedStringArray recents=, recents:PackedStringArray=, ):void
Sets the list of recent directories, which is shared by all FileDialog nodes. Useful to restore the list of recents saved with set_recent_list. This method can be called only from the main thread.

Note: FileDialog will update its internal ItemList of recent directories when its visibility changes. Be sure to call this method earlier if you want your changes to have effect.


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