mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
244 lines
10 KiB
ReStructuredText
244 lines
10 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/4.0/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/4.0/doc/classes/EditorFileSystem.xml.
|
|
|
|
.. _class_EditorFileSystem:
|
|
|
|
EditorFileSystem
|
|
================
|
|
|
|
**Inherits:** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
Resource filesystem, as the editor sees it.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
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 :ref:`EditorInterface.get_resource_filesystem<class_EditorInterface_method_get_resource_filesystem>`.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Methods
|
|
-------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :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:`reimport_files<class_EditorFileSystem_method_reimport_files>` **(** :ref:`PackedStringArray<class_PackedStringArray>` files **)** |
|
|
+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 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 **)** |
|
|
+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Signals
|
|
-------
|
|
|
|
.. _class_EditorFileSystem_signal_filesystem_changed:
|
|
|
|
.. rst-class:: classref-signal
|
|
|
|
**filesystem_changed** **(** **)**
|
|
|
|
Emitted if the filesystem changed.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorFileSystem_signal_resources_reimported:
|
|
|
|
.. rst-class:: classref-signal
|
|
|
|
**resources_reimported** **(** :ref:`PackedStringArray<class_PackedStringArray>` resources **)**
|
|
|
|
Emitted if a resource is reimported.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorFileSystem_signal_resources_reload:
|
|
|
|
.. rst-class:: classref-signal
|
|
|
|
**resources_reload** **(** :ref:`PackedStringArray<class_PackedStringArray>` resources **)**
|
|
|
|
Emitted if at least one resource is reloaded when the filesystem is scanned.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorFileSystem_signal_script_classes_updated:
|
|
|
|
.. rst-class:: classref-signal
|
|
|
|
**script_classes_updated** **(** **)**
|
|
|
|
Emitted when the list of global script classes gets updated.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorFileSystem_signal_sources_changed:
|
|
|
|
.. rst-class:: classref-signal
|
|
|
|
**sources_changed** **(** :ref:`bool<class_bool>` exist **)**
|
|
|
|
Emitted if the source of any imported file changed.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_EditorFileSystem_method_get_file_type:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`String<class_String>` **get_file_type** **(** :ref:`String<class_String>` path **)** |const|
|
|
|
|
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"``.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorFileSystem_method_get_filesystem:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`EditorFileSystemDirectory<class_EditorFileSystemDirectory>` **get_filesystem** **(** **)**
|
|
|
|
Gets the root directory object.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorFileSystem_method_get_filesystem_path:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`EditorFileSystemDirectory<class_EditorFileSystemDirectory>` **get_filesystem_path** **(** :ref:`String<class_String>` path **)**
|
|
|
|
Returns a view into the filesystem at ``path``.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorFileSystem_method_get_scanning_progress:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`float<class_float>` **get_scanning_progress** **(** **)** |const|
|
|
|
|
Returns the scan progress for 0 to 1 if the FS is being scanned.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorFileSystem_method_is_scanning:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`bool<class_bool>` **is_scanning** **(** **)** |const|
|
|
|
|
Returns ``true`` if the filesystem is being scanned.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorFileSystem_method_reimport_files:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
void **reimport_files** **(** :ref:`PackedStringArray<class_PackedStringArray>` files **)**
|
|
|
|
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 :ref:`update_file<class_EditorFileSystem_method_update_file>` or :ref:`scan<class_EditorFileSystem_method_scan>`.
|
|
|
|
\ **Note:** This function blocks until the import is finished. However, the main loop iteration, including timers and :ref:`Node._process<class_Node_method__process>`, will occur during the import process due to progress bar updates. Avoid calls to :ref:`reimport_files<class_EditorFileSystem_method_reimport_files>` or :ref:`scan<class_EditorFileSystem_method_scan>` while an import is in progress.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorFileSystem_method_scan:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
void **scan** **(** **)**
|
|
|
|
Scan the filesystem for changes.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorFileSystem_method_scan_sources:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
void **scan_sources** **(** **)**
|
|
|
|
Check if the source of any imported resource changed.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorFileSystem_method_update_file:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
void **update_file** **(** :ref:`String<class_String>` path **)**
|
|
|
|
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 :ref:`reimport_files<class_EditorFileSystem_method_reimport_files>` or :ref:`scan<class_EditorFileSystem_method_scan>` methods.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|