Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

DirAccess

Inherits: RefCounted < Object

Provides methods for managing directories and their content.

描述

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: 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. Use ResourceLoader to access imported resources.

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

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

教程

属性

bool

include_hidden

bool

include_navigational

Methods

Error

change_dir ( String to_dir )

Error

copy ( String from, String to, int chmod_flags=-1 )

Error

copy_absolute ( String from, String to, int chmod_flags=-1 ) static

bool

current_is_dir ( ) const

bool

dir_exists ( String path )

bool

dir_exists_absolute ( String path ) static

bool

file_exists ( String path )

String

get_current_dir ( bool include_drive=true ) const

int

get_current_drive ( )

PackedStringArray

get_directories ( )

PackedStringArray

get_directories_at ( String path ) static

int

get_drive_count ( ) static

String

get_drive_name ( int idx ) static

PackedStringArray

get_files ( )

PackedStringArray

get_files_at ( String path ) static

String

get_next ( )

Error

get_open_error ( ) static

int

get_space_left ( )

Error

list_dir_begin ( )

void

list_dir_end ( )

Error

make_dir ( String path )

Error

make_dir_absolute ( String path ) static

Error

make_dir_recursive ( String path )

Error

make_dir_recursive_absolute ( String path ) static

DirAccess

open ( String path ) static

Error

remove ( String path )

Error

remove_absolute ( String path ) static

Error

rename ( String from, String to )

Error

rename_absolute ( String from, String to ) static


Property Descriptions

bool include_hidden

  • void set_include_hidden ( bool value )

  • bool get_include_hidden ( )

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

Affects list_dir_begin, get_directories and get_files.


bool include_navigational

  • void set_include_navigational ( bool value )

  • bool get_include_navigational ( )

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

Affects list_dir_begin and get_directories.


Method Descriptions

Error change_dir ( String to_dir )

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


Error copy ( String from, String to, int chmod_flags=-1 )

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