DirAccess

Description

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:

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

		public void DirContents(string path)
		{
			using var dir = DirAccess.Open(path);
			if (dir != null)
			{
				dir.ListDirBegin();
				string fileName = dir.GetNext();
				while (fileName != "")
				{
					if (dir.CurrentIsDir())
					{
						GD.Print($"Found directory: {fileName}");
					}
					else
					{
						GD.Print($"Found file: {fileName}");
					}
					fileName = dir.GetNext();
				}
			}
			else
			{
				GD.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.

Properties

Methods

Tutorials

• File system