diff options
| author | Lyuma <xn.lyuma@gmail.com> | 2022-05-13 10:35:12 -0700 |
|---|---|---|
| committer | Lyuma <xn.lyuma@gmail.com> | 2022-05-17 00:45:48 -0700 |
| commit | 41824c6cc81c470a97d19269173aea8d53292da8 (patch) | |
| tree | f4a669406a491171d5ab20bd5d6076a5776fb34b /doc | |
| parent | 743fce68340c9f4e0aa171efb8e9c513e764cd00 (diff) | |
Bind EditorFileSystem::reimport_files and improve docs
reimport_files offers a way for scripts to modify imported resources directly.
For example, images, sounds or glTF documents which are written by an external program.
It is much faster than `scan`, and can allow scripts to synchronously proceed after import finishes.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/EditorFileSystem.xml | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/doc/classes/EditorFileSystem.xml b/doc/classes/EditorFileSystem.xml index 300cb4bfd6..60ac499d25 100644 --- a/doc/classes/EditorFileSystem.xml +++ b/doc/classes/EditorFileSystem.xml @@ -42,6 +42,15 @@ Returns [code]true[/code] of 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"> <return type="void" /> <description> @@ -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"> |