Directory

Type used to handle the filesystem.

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

When creating a new , its default opened directory will be res://. This may change in the future, so it is advised to always use to initialize your Directory where you want to operate, with explicit error checking.

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

• File system

• change_dir ( String todir )

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 code constants (OK on success).

• Error copy ( from, String to )

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.

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

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

• dir_exists ( String path )

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

• file_exists ( String path )

• get_current_dir ( )

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

• int get_current_drive ( )

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

• String get_drive ( idx )

On Windows, returns 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.

• int get_drive_count ( )

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

• get_next ( )

Returns the next element (file or directory) in the current directory (including . and .., unless skip_navigational was given to list_dir_begin).

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

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

• Error list_dir_begin ( skip_navigational=false, bool skip_hidden=false )

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

If skip_navigational is true, . and .. are filtered out.

If skip_hidden is , hidden files are filtered out.

• void list_dir_end ( )

• make_dir ( String path )

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

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

• make_dir_recursive ( String path )

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

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

• open ( String path )

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 one of the code constants (OK on success).

• Error remove ( path )

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.

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

• rename ( String from, to )

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

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