FileDialog

Inherits: ConfirmationDialog < AcceptDialog < WindowDialog < Popup < Control < CanvasItem < Node < Object Dialog for selecting files or directories in the filesystem.

Description

mode. If you want to use a custom title, disable this by setting mode_overrides_title to false.

Properties

Methods

Theme Properties

Signals

  • dir_selected ( String dir ) Emitted when the user selects a directory.
  • file_selected ( String path ) OK button.
  • files_selected ( PoolStringArray paths ) Emitted when the user selects multiple files.

    Enumerations

    Mode:
  • MODE_OPEN_FILE = 0 —- The dialog allows selecting one, and only one file.
  • MODE_OPEN_FILES = 1 —- The dialog allows selecting multiple files.
  • 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.

Access:

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

    Property Descriptions

  • Access access 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.
  • 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.
  • PoolStringArray filters .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 mode Mode constants.
  • bool mode_overrides_title true, changing the Mode property will set the window title accordingly (e.g. setting mode to MODE_OPEN_FILE will change the window title to “Open a File”).
  • bool show_hidden_files true, the dialog will show hidden files.

    Method Descriptions

  • add_filter ( String filter ) filter to the list of filters, which restricts what files can be picked. 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. "*.png ; PNG Images", "project.godot ; Godot Project".
  • clear_filters ( ) Clear all the added filters in the dialog.
  • deselect_items ( ) Clear currently selected items in the dialog.
  • LineEdit get_line_edit ( ) 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.
  • VBoxContainer get_vbox ( ) 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.
  • invalidate ( ) Invalidate and update the current dialog content list.

    Theme Property Descriptions

  • Color file_icon_modulate The color modulation applied to the file icon.
  • Color files_disabled FileDialog is used in open folder mode).
  • Color folder_icon_modulate The color modulation applied to the folder icon.
  • Texture file Custom icon for files.
  • Texture folder Custom icon for folders.
  • Texture parent_folder Custom icon for the parent folder arrow.
  • Texture reload Custom icon for the reload button.
  • Texture toggle_hidden Custom icon for the toggle hidden button.