godot-docs/classes/class_editorfilesystem.rst

:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the EditorFileSystem.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_EditorFileSystem:

EditorFileSystem
================

**Inherits:** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

**Category:** Core

Brief Description
-----------------

Resource filesystem, as the editor sees it.

Methods
-------

+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                                       | :ref:`get_file_type<class_EditorFileSystem_method_get_file_type>` **(** :ref:`String<class_String>` path **)** const       |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`EditorFileSystemDirectory<class_EditorFileSystemDirectory>` | :ref:`get_filesystem<class_EditorFileSystem_method_get_filesystem>` **(** **)**                                            |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`EditorFileSystemDirectory<class_EditorFileSystemDirectory>` | :ref:`get_filesystem_path<class_EditorFileSystem_method_get_filesystem_path>` **(** :ref:`String<class_String>` path **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                                         | :ref:`get_scanning_progress<class_EditorFileSystem_method_get_scanning_progress>` **(** **)** const                        |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                                           | :ref:`is_scanning<class_EditorFileSystem_method_is_scanning>` **(** **)** const                                            |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void                                                              | :ref:`scan<class_EditorFileSystem_method_scan>` **(** **)**                                                                |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void                                                              | :ref:`scan_sources<class_EditorFileSystem_method_scan_sources>` **(** **)**                                                |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void                                                              | :ref:`update_file<class_EditorFileSystem_method_update_file>` **(** :ref:`String<class_String>` path **)**                 |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void                                                              | :ref:`update_script_classes<class_EditorFileSystem_method_update_script_classes>` **(** **)**                              |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+

Signals
-------

.. _class_EditorFileSystem_signal_filesystem_changed:

- **filesystem_changed** **(** **)**

Emitted if the filesystem changed.

----

.. _class_EditorFileSystem_signal_resources_reimported:

- **resources_reimported** **(** :ref:`PoolStringArray<class_PoolStringArray>` resources **)**

Remitted if a resource is reimported.

----

.. _class_EditorFileSystem_signal_resources_reload:

- **resources_reload** **(** :ref:`PoolStringArray<class_PoolStringArray>` resources **)**

----

.. _class_EditorFileSystem_signal_sources_changed:

- **sources_changed** **(** :ref:`bool<class_bool>` exist **)**

Emitted if the source of any imported file changed.

Description
-----------

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

Method Descriptions
-------------------

.. _class_EditorFileSystem_method_get_file_type:

- :ref:`String<class_String>` **get_file_type** **(** :ref:`String<class_String>` path **)** const

Get the type of the file, given the full path.

----

.. _class_EditorFileSystem_method_get_filesystem:

- :ref:`EditorFileSystemDirectory<class_EditorFileSystemDirectory>` **get_filesystem** **(** **)**

Get the root directory object.

----

.. _class_EditorFileSystem_method_get_filesystem_path:

- :ref:`EditorFileSystemDirectory<class_EditorFileSystemDirectory>` **get_filesystem_path** **(** :ref:`String<class_String>` path **)**

Returns a view into the filesystem at ``path``.

----

.. _class_EditorFileSystem_method_get_scanning_progress:

- :ref:`float<class_float>` **get_scanning_progress** **(** **)** const

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

----

.. _class_EditorFileSystem_method_is_scanning:

- :ref:`bool<class_bool>` **is_scanning** **(** **)** const

Returns ``true`` of the filesystem is being scanned.

----

.. _class_EditorFileSystem_method_scan:

- void **scan** **(** **)**

Scan the filesystem for changes.

----

.. _class_EditorFileSystem_method_scan_sources:

- void **scan_sources** **(** **)**

Check if the source of any imported resource changed.

----

.. _class_EditorFileSystem_method_update_file:

- void **update_file** **(** :ref:`String<class_String>` path **)**

Update a file information. Call this if an external program (not Godot) modified the file.

----

.. _class_EditorFileSystem_method_update_script_classes:

- void **update_script_classes** **(** **)**