Pārlūkot izejas kodu

Merge pull request #106439 from timothyqiu/import-out-params

Document output parameters of `EditorImportPlugin.import`
Thaddeus Crews 3 mēneši atpakaļ
vecāks
revīzija
a7a61cc284
1 mainītis faili ar 3 papildinājumiem un 1 dzēšanām
  1. 3 1
      doc/classes/EditorImportPlugin.xml

+ 3 - 1
doc/classes/EditorImportPlugin.xml

@@ -237,7 +237,9 @@
 			<param index="3" name="platform_variants" type="String[]" />
 			<param index="3" name="platform_variants" type="String[]" />
 			<param index="4" name="gen_files" type="String[]" />
 			<param index="4" name="gen_files" type="String[]" />
 			<description>
 			<description>
-				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.
+				Imports [param source_file] with the import [param options] specified. Should return [constant @GlobalScope.OK] if the import is successful, other values indicate failure.
+				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].
+				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].
 				This method must be overridden to do the actual importing work. See this class' description for an example of overriding this method.
 				This method must be overridden to do the actual importing work. See this class' description for an example of overriding this method.
 			</description>
 			</description>
 		</method>
 		</method>