Class DirAccess

Provides methods for managing directories and their content.

Inheritance

RefCounted

Object

DirAccess

Remarks

This class is used to manage directories and their content, even outside of the project folder.

DirAccess can't be instantiated directly. Instead it is created with a static method that takes a path for which it will be opened.

Most of the methods have a static alternative that can be used without creating a DirAccess. Static methods only support absolute paths (including res:// and user://).

# Standard
var dir = DirAccess.open("user://levels")
dir.make_dir("world1")
# Static
DirAccess.make_dir_absolute("user://levels/world1")

Note: Accessing project ("res://") directories once exported may behave unexpectedly as some files are converted to engine-specific formats and their original source files may not be present in the expected PCK package. Because of this, to access resources in an exported project, it is recommended to use ResourceLoader instead of FileAccess.

Here is an example on how to iterate through the files of a directory:

• gdscript
• C#

func dir_contents(path):
    var dir = DirAccess.open(path)
    if dir:
        dir.list_dir_begin()
        var file_name = dir.get_next()
        while file_name != "":
            if dir.current_is_dir():
                print("Found directory: " + file_name)
            else:
                print("Found file: " + file_name)
            file_name = dir.get_next()
    else:
        print("An error occurred when trying to access the path.")

Keep in mind that file names may change or be remapped after export. If you want to see the actual resource file list as it appears in the editor, use ResourceLoader.list_directory instead.

See Also

File system

Properties

include_hidden

If true, hidden files are included when navigating the directory.

Affects list_dir_begin, get_directories and get_files.

var include_hidden : bool

Property Value

bool

Remarks

• void set_include_hidden(bool value)
• bool get_include_hidden

include_navigational

If true, . and .. are included when navigating the directory.

Affects list_dir_begin and get_directories.

var include_navigational : bool

Property Value

bool

Remarks

• void set_include_navigational(bool value)
• bool get_include_navigational

Methods

change_dir(String)

Changes the currently opened directory to the one passed as an argument. The argument can be relative to the current directory (e.g. newdir or ../newdir), or an absolute path (e.g. /tmp/newdir or res://somedir/newdir).

Returns one of the Error code constants (@GlobalScope.OK on success).

Note: The new directory must be within the same scope, e.g. when you had opened a directory inside res://, you can't change it to user:// directory. If you need to open a directory in another access scope, use DirAccess.open to create a new instance instead.

int change_dir(String to_dir)

Parameters

to_dir String

copy(String, String, int)

Copies the from file to the to destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten.

If chmod_flags is different than -1, the Unix permissions for the destination path will be set to the provided value, if available on the current operating system.

Returns one of the Error code constants (@GlobalScope.OK on success).

int copy(String from, String to, int chmod_flags)

Parameters

from String

to String

chmod_flags int

copy_absolute(String, String, int)

Qualifiers: static

Static version of DirAccess.copy. Supports only absolute paths.

int copy_absolute(String from, String to, int chmod_flags)

Parameters

from String

to String

chmod_flags int

create_link(String, String)

Creates symbolic link between files or folders.

Note: On Windows, this method works only if the application is running with elevated privileges or Developer Mode is enabled.

Note: This method is implemented on macOS, Linux, and Windows.

int create_link(String source, String target)

Parameters

source String

target String

create_temp(String, bool)

Qualifiers: static

Creates a temporary directory. This directory will be freed when the returned DirAccess is freed.

If prefix is not empty, it will be prefixed to the directory name, separated by a -.

If keep is true, the directory is not deleted when the returned DirAccess is freed.

Returns null if opening the directory failed. You can use get_open_error to check the error that occurred.

DirAccess create_temp(String prefix, bool keep)

Parameters

prefix String

keep bool

current_is_dir

Qualifiers: const

Returns whether the current item processed with the last get_next call is a directory (. and .. are considered directories).

bool current_is_dir

dir_exists(String)

Returns whether the target directory exists. The argument can be relative to the current directory, or an absolute path.

Note: The returned bool in the editor and after exporting when used on a path in the res:// directory may be different. Some files are converted to engine-specific formats when exported, potentially changing the directory structure.

bool dir_exists(String path)

Parameters

path String

dir_exists_absolute(String)

Qualifiers: static

Static version of DirAccess.dir_exists. Supports only absolute paths.

Note: The returned bool in the editor and after exporting when used on a path in the res:// directory may be different. Some files are converted to engine-specific formats when exported, potentially changing the directory structure.

bool dir_exists_absolute(String path)

Parameters

path String

file_exists(String)

Returns whether the target file exists. The argument can be relative to the current directory, or an absolute path.

For a static equivalent, use FileAccess.file_exists.

Note: Many resources types are imported (e.g. textures or sound files), and their source asset will not be included in the exported game, as only the imported version is used. See ResourceLoader.exists for an alternative approach that takes resource remapping into account.

bool file_exists(String path)

Parameters

path String

get_current_dir(bool)

Qualifiers: const

Returns the absolute path to the currently opened directory (e.g. res://folder or C:\tmp\folder).

String get_current_dir(bool include_drive)

Parameters

include_drive bool

get_current_drive

Returns the currently opened directory's drive index. See DirAccess.get_drive_name to convert returned index to the name of the drive.

int get_current_drive

get_directories

Returns a PackedStringArray containing filenames of the directory contents, excluding files. The array is sorted alphabetically.

Affected by include_hidden and include_navigational.

Note: The returned directories in the editor and after exporting in the res:// directory may differ as some files are converted to engine-specific formats when exported.

PackedStringArray get_directories

get_directories_at(String)

Qualifiers: static

Returns a PackedStringArray containing filenames of the directory contents, excluding files, at the given path. The array is sorted alphabetically.

Use get_directories if you want more control of what gets included.

Note: The returned directories in the editor and after exporting in the res:// directory may differ as some files are converted to engine-specific formats when exported.

PackedStringArray get_directories_at(String path)

Parameters

path String

get_drive_count

Qualifiers: static

On Windows, returns the number of drives (partitions) mounted on the current filesystem.

On macOS, returns the number of mounted volumes.

On Linux, returns the number of mounted volumes and GTK 3 bookmarks.

On other platforms, the method returns 0.

int get_drive_count

get_drive_name(int)

Qualifiers: static

On Windows, returns the name of the drive (partition) passed as an argument (e.g. C:).

On macOS, returns the path to the mounted volume passed as an argument.

On Linux, returns the path to the mounted volume or GTK 3 bookmark passed as an argument.

On other platforms, or if the requested drive does not exist, the method returns an empty String.

String get_drive_name(int idx)

Parameters

idx int

get_files

Returns a PackedStringArray containing filenames of the directory contents, excluding directories. The array is sorted alphabetically.

Affected by include_hidden.

Note: When used on a res:// path in an exported project, only the files actually included in the PCK at the given folder level are returned. In practice, this means that since imported resources are stored in a top-level .godot/ folder, only paths to *.gd and *.import files are returned (plus a few files such as project.godot or project.binary and the project icon). In an exported project, the list of returned files will also vary depending on whether editor/export/convert_text_resources_to_binary is true.

PackedStringArray get_files

get_files_at(String)

Qualifiers: static

Returns a PackedStringArray containing filenames of the directory contents, excluding directories, at the given path. The array is sorted alphabetically.

Use get_files if you want more control of what gets included.

Note: When used on a res:// path in an exported project, only the files included in the PCK at the given folder level are returned. In practice, this means that since imported resources are stored in a top-level .godot/ folder, only paths to .gd and .import files are returned (plus a few other files, such as project.godot or project.binary and the project icon). In an exported project, the list of returned files will also vary depending on editor/export/convert_text_resources_to_binary.

PackedStringArray get_files_at(String path)

Parameters

path String

get_next

Returns the next element (file or directory) in the current directory.

The name of the file or directory is returned (and not its full path). Once the stream has been fully processed, the method returns an empty String and closes the stream automatically (i.e. list_dir_end would not be mandatory in such a case).

String get_next

get_open_error

Qualifiers: static

Returns the result of the last DirAccess.open call in the current thread.

int get_open_error

get_space_left

Returns the available space on the current directory's disk, in bytes. Returns 0 if the platform-specific method to query the available space fails.

int get_space_left

is_bundle(String)

Qualifiers: const

Returns true if the directory is a macOS bundle.

Note: This method is implemented on macOS.

bool is_bundle(String path)

Parameters

path String

is_case_sensitive(String)

Qualifiers: const

Returns true if the file system or directory use case sensitive file names.

Note: This method is implemented on macOS, Linux (for EXT4 and F2FS filesystems only) and Windows. On other platforms, it always returns true.

bool is_case_sensitive(String path)

Parameters

path String

is_link(String)

Returns true if the file or directory is a symbolic link, directory junction, or other reparse point.

Note: This method is implemented on macOS, Linux, and Windows.

bool is_link(String path)

Parameters

path String

list_dir_begin

Initializes the stream used to list all files and directories using the get_next function, closing the currently opened stream if needed. Once the stream has been processed, it should typically be closed with list_dir_end.

Affected by include_hidden and include_navigational.

Note: The order of files and directories returned by this method is not deterministic, and can vary between operating systems. If you want a list of all files or folders sorted alphabetically, use get_files or get_directories.

int list_dir_begin

list_dir_end

Closes the current stream opened with list_dir_begin (whether it has been fully processed with get_next does not matter).

void list_dir_end

make_dir(String)

Creates a directory. The argument can be relative to the current directory, or an absolute path. The target directory should be placed in an already existing directory (to create the full path recursively, see DirAccess.make_dir_recursive).

Returns one of the Error code constants (@GlobalScope.OK on success).

int make_dir(String path)

Parameters

path String

make_dir_absolute(String)

Qualifiers: static

Static version of DirAccess.make_dir. Supports only absolute paths.

int make_dir_absolute(String path)

Parameters

path String

make_dir_recursive(String)

Creates a target directory and all necessary intermediate directories in its path, by calling DirAccess.make_dir recursively. The argument can be relative to the current directory, or an absolute path.

Returns one of the Error code constants (@GlobalScope.OK on success).

int make_dir_recursive(String path)

Parameters

path String

make_dir_recursive_absolute(String)

Qualifiers: static

Static version of DirAccess.make_dir_recursive. Supports only absolute paths.

int make_dir_recursive_absolute(String path)

Parameters

path String

open(String)

Qualifiers: static

Creates a new DirAccess object and opens an existing directory of the filesystem. The path argument can be within the project tree (res://folder), the user directory (user://folder) or an absolute path of the user filesystem (e.g. /tmp/folder or C:\tmp\folder).

Returns null if opening the directory failed. You can use get_open_error to check the error that occurred.

DirAccess open(String path)

Parameters

path String

read_link(String)

Returns target of the symbolic link.

Note: This method is implemented on macOS, Linux, and Windows.

String read_link(String path)

Parameters

path String

remove(String)

Permanently deletes the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail.

If you don't want to delete the file/directory permanently, use OS.move_to_trash instead.

Returns one of the Error code constants (@GlobalScope.OK on success).

int remove(String path)

Parameters

path String

remove_absolute(String)

Qualifiers: static

Static version of DirAccess.remove. Supports only absolute paths.

int remove_absolute(String path)

Parameters

path String

rename(String, String)

Renames (move) the from file or directory to the to destination. Both arguments should be paths to files or directories, either relative or absolute. If the destination file or directory exists and is not access-protected, it will be overwritten.

Returns one of the Error code constants (@GlobalScope.OK on success).

int rename(String from, String to)

Parameters

from String

to String

rename_absolute(String, String)

Qualifiers: static

Static version of DirAccess.rename. Supports only absolute paths.

int rename_absolute(String from, String to)

Parameters

from String

to String