Directory

Inherits: Reference < Object

Category: Core

Brief Description

Type used to handle the filesystem.

Member Functions

int	change_dir ( String todir )
int	copy ( String from, String to )
bool	current_is_dir ( ) const
bool	dir_exists ( String path )
bool	file_exists ( String path )
String	get_current_dir ( )
int	get_current_drive ( )
String	get_drive ( int idx )
int	get_drive_count ( )
String	get_next ( )
int	get_space_left ( )
int	list_dir_begin ( bool skip_navigational=false, bool skip_hidden=false )
void	list_dir_end ( )
int	make_dir ( String path )
int	make_dir_recursive ( String path )
int	open ( String path )
int	remove ( String path )
int	rename ( String from, String to )

Description

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:

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

Member Function Description

• int change_dir ( 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 @Global Scope (OK or ERR_*).

• int 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 @Global Scope (OK, FAILED or ERR_*).

• bool current_is_dir ( ) const

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

• bool dir_exists ( String path )

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

• bool file_exists ( String path )

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

• String get_current_dir ( )

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

• int get_current_drive ( )

• String get_drive ( 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.

• int get_drive_count ( )

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

• String get_next ( )

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

• int get_space_left ( )

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.

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

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

Return true if the stream could not be initialised.

• void list_dir_end ( )

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

• int make_dir ( 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 make_dir_recursive).

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

• int make_dir_recursive ( String path )

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

Return one of the error code constants defined in @Global Scope (OK, FAILED or ERR_*).

• int 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 @Global Scope (OK or ERR_*).

• int 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 @Global Scope (OK or FAILED).

• int 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 @Global Scope (OK or FAILED).