summaryrefslogtreecommitdiff
path: root/doc/classes/EditorFileSystem.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/EditorFileSystem.xml')
-rw-r--r--doc/classes/EditorFileSystem.xml14
1 files changed, 12 insertions, 2 deletions
diff --git a/doc/classes/EditorFileSystem.xml b/doc/classes/EditorFileSystem.xml
index 300cb4bfd6..402efba34a 100644
--- a/doc/classes/EditorFileSystem.xml
+++ b/doc/classes/EditorFileSystem.xml
@@ -39,7 +39,16 @@
<method name="is_scanning" qualifiers="const">
<return type="bool" />
<description>
- Returns [code]true[/code] of the filesystem is being scanned.
+ Returns [code]true[/code] if the filesystem is being scanned.
+ </description>
+ </method>
+ <method name="reimport_files">
+ <return type="void" />
+ <argument index="0" name="files" type="PackedStringArray" />
+ <description>
+ Reimports a set of files. Call this if these files or their [code].import[/code] files were directly edited by script or an external program.
+ If the file type changed or the file was newly created, use [method update_file] or [method scan].
+ [b]Note:[/b] This function blocks until the import is finished. However, the main loop iteration, including timers and [method Node._process], will occur during the import process due to progress bar updates. Avoid calls to [method reimport_files] or [method scan] while an import is in progress.
</description>
</method>
<method name="scan">
@@ -58,7 +67,8 @@
<return type="void" />
<argument index="0" name="path" type="String" />
<description>
- Update a file information. Call this if an external program (not Godot) modified the file.
+ 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 [method reimport_files] or [method scan] methods.
</description>
</method>
<method name="update_script_classes">