Type used to handle the filesystem.
    public class Directory : Reference

Directory type. It is used to manage directories and their content (not restricted to the project folder).

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

[codeblock]

func dir_contents(path):

var dir = Directory.new()

if dir.open(path) == OK:

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

[/codeblock]

Inheritance Chain

Constructors

    public Directory()

Methods

    public Error ChangeDir(string todir)

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

The method returns one of the error code constants defined in [@GlobalScope] (OK or ERR_*).

    public Error Copy(string from, string to)

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

Returns one of the error code constants defined in [@GlobalScope] (OK, FAILED or ERR_*).

    public bool CurrentIsDir()

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

    public bool DirExists(string path)

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

    public bool FileExists(string path)

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

    public string GetCurrentDir()

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

    public int GetCurrentDrive()

Returns the currently opened directory’s drive index. See GetDrive(int) to convert returned index to the name of the drive.

    public string GetDrive(int idx)

On Windows, return the name of the drive (partition) passed as an argument (e.g. C:). On other platforms, or if the requested drive does not existed, the method returns an empty String.

    public int GetDriveCount()

On Windows, return the number of drives (partitions) mounted on the current filesystem. On other platforms, the method returns 0.

    public string GetNext()

Return the next element (file or directory) in the current directory (including . and .., unless skip_navigational was given to ListDirBegin(bool, bool)).

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. ListDirEnd() would not be mandatory in such a case).

    public int GetSpaceLeft()

On Unix desktop systems, return the available space on the current directory’s disk. On other platforms, this information is not available and the method returns 0 or -1.

    public Error ListDirBegin(bool skipNavigational = false, bool skipHidden = false)

Initialise the stream used to list all files and directories using the GetNext() function, closing the current opened stream if needed. Once the stream has been processed, it should typically be closed with ListDirEnd().

If you pass skipNavigational, then . and .. would be filtered out.

If you pass skipHidden, then hidden files would be filtered out.

    public void ListDirEnd()

Close the current stream opened with ListDirBegin(bool, bool) (whether it has been fully processed with GetNext() or not does not matter).

    public Error MakeDir(string path)

Create 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 MakeDirRecursive(string)).

The method returns one of the error code constants defined in [@GlobalScope] (OK, FAILED or ERR_*).

    public Error MakeDirRecursive(string path)

Create a target directory and all necessary intermediate directories in its path, by calling MakeDir(string) recursively. The argument can be relative to the current directory, or an absolute path.

Return one of the error code constants defined in [@GlobalScope] (OK, FAILED or ERR_*).

    public Error Open(string path)

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

The method returns one of the error code constants defined in [@GlobalScope] (OK or ERR_*).

    public Error Remove(string path)

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

Return one of the error code constants defined in [@GlobalScope] (OK or FAILED).

    public Error Rename(string from, string to)

Rename (move) 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.

Return one of the error code constants defined in [@GlobalScope] (OK or FAILED).

Tags: