Inheritance #

EditorFileSystem

Table of contents

EditorFileSystem #

Node, editor, not_builtin_classes

Resource filesystem, as the editor sees it.

This object holds information of all resources in the filesystem, their types, etc.

Note: This class shouldn't be instantiated directly. Instead, access the singleton using EditorInterface.get_resource_filesystem.

Members #

Methods #

const func get_file_type(path: String) -> String#

Returns the resource type of the file, given the full path. This returns a string such as "Resource" or "GDScript", not a file extension such as ".gd".

func get_filesystem() -> EditorFileSystemDirectory#

Gets the root directory object.

func get_filesystem_path(path: String) -> EditorFileSystemDirectory#

Returns a view into the filesystem at path.

const func get_scanning_progress() -> float#

Returns the scan progress for 0 to 1 if the FS is being scanned.

const func is_scanning() -> bool#

Returns true if the filesystem is being scanned.

func reimport_files(files: PackedStringArray) -> void#

Reimports a set of files. Call this if these files or their .import files were directly edited by script or an external program.

If the file type changed or the file was newly created, use update_file or scan.

Note: This function blocks until the import is finished. However, the main loop iteration, including timers and Node._process, will occur during the import process due to progress bar updates. Avoid calls to reimport_files or scan while an import is in progress.

func scan() -> void#

Scan the filesystem for changes.

func scan_sources() -> void#

Check if the source of any imported resource changed.

func update_file(path: String) -> void#

Add a file in an existing directory, or schedule file information to be updated on editor restart. Can be used to update text files saved by an external program.

This will not import the file. To reimport, call reimport_files or scan methods.

Annotations #

Constants #

Constructors #

Enums #

Operators #

Signals #

signal filesystem_changed()#

Emitted if the filesystem changed.

signal resources_reimported(resources: PackedStringArray)#

Emitted if a resource is reimported.

signal resources_reimporting(resources: PackedStringArray)#

Emitted before a resource is reimported.

signal resources_reload(resources: PackedStringArray)#

Emitted if at least one resource is reloaded when the filesystem is scanned.

signal script_classes_updated()#

Emitted when the list of global script classes gets updated.

signal sources_changed(exist: bool)#

Emitted if the source of any imported file changed.

Theme Items #

Tutorials #