Skip to content

Commit a7a61cc

Browse files
committed
Merge pull request godotengine#106439 from timothyqiu/import-out-params
Document output parameters of `EditorImportPlugin.import`
2 parents 1069cb1 + c31746f commit a7a61cc

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

doc/classes/EditorImportPlugin.xml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,9 @@
237237
<param index="3" name="platform_variants" type="String[]" />
238238
<param index="4" name="gen_files" type="String[]" />
239239
<description>
240-
Imports [param source_file] into [param save_path] with the import [param options] specified. The [param platform_variants] and [param gen_files] arrays will be modified by this function.
240+
Imports [param source_file] with the import [param options] specified. Should return [constant @GlobalScope.OK] if the import is successful, other values indicate failure.
241+
The imported resource is expected to be saved to [code]save_path + "." + _get_save_extension()[/code]. If a different variant is preferred for a [url=$DOCS_URL/tutorials/export/feature_tags.html]feature tag[/url], save the variant to [code]save_path + "." + tag + "." + _get_save_extension()[/code] and add the feature tag to [param platform_variants].
242+
If additional resource files are generated in the resource filesystem ([code]res://[/code]), add their full path to [param gen_files] so that the editor knows they depend on [param source_file].
241243
This method must be overridden to do the actual importing work. See this class' description for an example of overriding this method.
242244
</description>
243245
</method>

0 commit comments

Comments
 (0)