FileDialog

    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. The FileDialog automatically sets its window title according to the . If you want to use a custom title, disable this by setting mode_overrides_title to .

    Properties

    Methods

    void

    ( String filter )

    void

    ( )

    void

    deselect_items ( )

    get_line_edit ( )

    get_vbox ( )

    void

    ( )

    file_icon_modulate

    Color( 1, 1, 1, 1 )

    files_disabled

    Color( 1, 1, 1, 0.25 )

    Color( 1, 1, 1, 1 )

    Texture

    Texture

    Texture

    Texture

    Texture

    Signals

    • dir_selected ( 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 ( paths )

    Emitted when the user selects multiple files.

    Enumerations

    enum Mode:

    • MODE_OPEN_FILE = 0 —- The dialog allows selecting one, and only one file.

    • MODE_OPEN_DIR = 2 —- The dialog only allows selecting a directory, disallowing the selection of any file.

    • MODE_OPEN_ANY = 3 —- The dialog allows selecting one file or directory.

    • MODE_SAVE_FILE = 4 —- The dialog will warn when a file exists.

    enum Access:

    • ACCESS_RESOURCES = 0 —- The dialog only allows accessing files under the path (res://).

    • ACCESS_USERDATA = 1 —- The dialog only allows accessing files under user data path ().

    • ACCESS_FILESYSTEM = 2 —- The dialog allows accessing files on the whole file system.

    • access

    Default

    0

    Setter

    set_access(value)

    Getter

    get_access()

    The file system access scope. See enum Access constants.

    Warning: Currently, in sandboxed environments such as HTML5 builds or sandboxed macOS apps, FileDialog cannot access the host file system. See godot-proposals#1123.

    • current_dir

    The current working directory of the file dialog.

    Setter

    set_current_file(value)

    Getter

    get_current_file()

    The currently selected file of the file dialog.

    • current_path

    Setter

    set_current_path(value)

    Getter

    get_current_path()

    The currently selected file path of the file dialog.

    Default

    Setter

    set_filters(value)

    Getter

    get_filters()

    The available file type filters. For example, this shows only .png and .gd files: set_filters(PoolStringArray(["*.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.

    • mode

    The dialog’s open or save mode, which affects the selection behavior. See enum Mode constants.

    • bool mode_overrides_title

    Default

    true

    Setter

    set_mode_overrides_title(value)

    Getter

    is_mode_overriding_title()

    If true, changing the property will set the window title accordingly (e.g. setting mode to will change the window title to “Open a File”).

    Default

    false

    Setter

    set_show_hidden_files(value)

    Getter

    is_showing_hidden_files()

    If true, the dialog will show hidden files.

    Method Descriptions

    • void add_filter ( filter )

    Adds filter to the list of filters, which restricts what files can be picked.

    A filter should be of the form "filename.extension ; Description", where filename and extension can be * to match any string. Filters starting with . (i.e. empty filenames) are not allowed.

    Example filters: "*.png ; PNG Images", "project.godot ; Godot Project".

    • void clear_filters ( )

    Clear all the added filters in the dialog.

    • void deselect_items ( )

    Clear currently selected items in the dialog.

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

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

    • void invalidate ( )

    Invalidate and update the current dialog content list.

    Theme Property Descriptions

    • file_icon_modulate

    Default

    Color( 1, 1, 1, 1 )

    The color modulation applied to the file icon.

    The color tint for disabled files (when the is used in open folder mode).

    • folder_icon_modulate

    Default

    Color( 1, 1, 1, 1 )

    The color modulation applied to the folder icon.

    Custom icon for files.

    • folder

    Custom icon for folders.

    Custom icon for the parent folder arrow.

    • reload

    Custom icon for the toggle hidden button.