<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorImportPlugin" inherits="ResourceImporter" api_type="editor" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Registers a custom resource importer in the editor. Use the class to parse any file and import it as a new resource type.
	</brief_description>
	<description>
		[EditorImportPlugin]s provide a way to extend the editor's resource import functionality. Use them to import resources from custom files or to provide alternatives to the editor's existing importers.
		EditorImportPlugins work by associating with specific file extensions and a resource type. See [method _get_recognized_extensions] and [method _get_resource_type]. They may optionally specify some import presets that affect the import process. EditorImportPlugins are responsible for creating the resources and saving them in the [code].godot/imported[/code] directory (see [member ProjectSettings.application/config/use_hidden_project_data_directory]).
		Below is an example EditorImportPlugin that imports a [Mesh] from a file with the extension ".special" or ".spec":
		[codeblocks]
		[gdscript]
		@tool
		extends EditorImportPlugin

		func _get_importer_name():
			return "my.special.plugin"

		func _get_visible_name():
			return "Special Mesh"

		func _get_recognized_extensions():
			return ["special", "spec"]

		func _get_save_extension():
			return "mesh"

		func _get_resource_type():
			return "Mesh"

		func _get_preset_count():
			return 1

		func _get_preset_name(preset_index):
			return "Default"

		func _get_import_options(path, preset_index):
			return [{"name": "my_option", "default_value": false}]

		func _import(source_file, save_path, options, platform_variants, gen_files):
			var file = FileAccess.open(source_file, FileAccess.READ)
			if file == null:
				return FAILED
			var mesh = ArrayMesh.new()
			# Fill the Mesh with data read in "file", left as an exercise to the reader.

			var filename = save_path + "." + _get_save_extension()
			return ResourceSaver.save(mesh, filename)
		[/gdscript]
		[csharp]
		using Godot;

		public partial class MySpecialPlugin : EditorImportPlugin
		{
			public override string _GetImporterName()
			{
				return "my.special.plugin";
			}

			public override string _GetVisibleName()
			{
				return "Special Mesh";
			}

			public override string[] _GetRecognizedExtensions()
			{
				return ["special", "spec"];
			}

			public override string _GetSaveExtension()
			{
				return "mesh";
			}

			public override string _GetResourceType()
			{
				return "Mesh";
			}

			public override int _GetPresetCount()
			{
				return 1;
			}

			public override string _GetPresetName(int presetIndex)
			{
				return "Default";
			}

			public override Godot.Collections.Array&lt;Godot.Collections.Dictionary&gt; _GetImportOptions(string path, int presetIndex)
			{
				return
				[
					new Godot.Collections.Dictionary
					{
						{ "name", "myOption" },
						{ "default_value", false },
					},
				];
			}

			public override Error _Import(string sourceFile, string savePath, Godot.Collections.Dictionary options, Godot.Collections.Array&lt;string&gt; platformVariants, Godot.Collections.Array&lt;string&gt; genFiles)
			{
				using var file = FileAccess.Open(sourceFile, FileAccess.ModeFlags.Read);
				if (file.GetError() != Error.Ok)
				{
					return Error.Failed;
				}

				var mesh = new ArrayMesh();
				// Fill the Mesh with data read in "file", left as an exercise to the reader.
				string filename = $"{savePath}.{_GetSaveExtension()}";
				return ResourceSaver.Save(mesh, filename);
			}
		}
		[/csharp]
		[/codeblocks]
		To use [EditorImportPlugin], register it using the [method EditorPlugin.add_import_plugin] method first.
	</description>
	<tutorials>
		<link title="Import plugins">$DOCS_URL/tutorials/plugins/editor/import_plugins.html</link>
	</tutorials>
	<methods>
		<method name="_can_import_threaded" qualifiers="virtual const">
			<return type="bool" />
			<description>
				Tells whether this importer can be run in parallel on threads, or, on the contrary, it's only safe for the editor to call it from the main thread, for one file at a time.
				If this importer's implementation is thread-safe and can be run in parallel, override this with [code]true[/code] to optimize for concurrency.
				If not overridden, returns [code]false[/code].
			</description>
		</method>
		<method name="_get_format_version" qualifiers="virtual const">
			<return type="int" />
			<description>
				Gets the format version of this importer. Increment this version when making incompatible changes to the format of the imported resources.
				If not overridden, the format version is [code]0[/code].
			</description>
		</method>
		<method name="_get_import_options" qualifiers="virtual required const">
			<return type="Dictionary[]" />
			<param index="0" name="path" type="String" />
			<param index="1" name="preset_index" type="int" />
			<description>
				Gets the options and default values for the preset at this index. Returns an Array of Dictionaries with the following keys: [code]name[/code], [code]default_value[/code], [code]property_hint[/code] (optional), [code]hint_string[/code] (optional), [code]usage[/code] (optional).
			</description>
		</method>
		<method name="_get_import_order" qualifiers="virtual const">
			<return type="int" />
			<description>
				Gets the order of this importer to be run when importing resources. Importers with [i]lower[/i] import orders will be called first, and higher values will be called later. Use this to ensure the importer runs after the dependencies are already imported. The default import order is [code]0[/code] unless overridden by a specific importer. See [enum ResourceImporter.ImportOrder] for some predefined values.
			</description>
		</method>
		<method name="_get_importer_name" qualifiers="virtual required const">
			<return type="String" />
			<description>
				Gets the unique name of the importer.
			</description>
		</method>
		<method name="_get_option_visibility" qualifiers="virtual const">
			<return type="bool" />
			<param index="0" name="path" type="String" />
			<param index="1" name="option_name" type="StringName" />
			<param index="2" name="options" type="Dictionary" />
			<description>
				Gets whether the import option specified by [param option_name] should be visible in the Import dock. The default implementation always returns [code]true[/code], making all options visible. This is mainly useful for hiding options that depend on others if one of them is disabled.
				[codeblocks]
				[gdscript]
				func _get_option_visibility(path, option_name, options):
					# Only show the lossy quality setting if the compression mode is set to "Lossy".
					if option_name == "compress/lossy_quality" and options.has("compress/mode"):
						return int(options["compress/mode"]) == COMPRESS_LOSSY # This is a constant that you set

					return true
				[/gdscript]
				[csharp]
				public override bool _GetOptionVisibility(string path, StringName optionName, Godot.Collections.Dictionary options)
				{
					// Only show the lossy quality setting if the compression mode is set to "Lossy".
					if (optionName == "compress/lossy_quality" &amp;&amp; options.ContainsKey("compress/mode"))
					{
						return (int)options["compress/mode"] == CompressLossy; // This is a constant you set
					}

					return true;
				}
				[/csharp]
				[/codeblocks]
			</description>
		</method>
		<method name="_get_preset_count" qualifiers="virtual const">
			<return type="int" />
			<description>
				Gets the number of initial presets defined by the plugin. Use [method _get_import_options] to get the default options for the preset and [method _get_preset_name] to get the name of the preset.
				By default, there are no presets.
			</description>
		</method>
		<method name="_get_preset_name" qualifiers="virtual required const">
			<return type="String" />
			<param index="0" name="preset_index" type="int" />
			<description>
				Gets the name of the options preset at this index.
			</description>
		</method>
		<method name="_get_priority" qualifiers="virtual const">
			<return type="float" />
			<description>
				Gets the priority of this plugin for the recognized extension. Higher priority plugins will be preferred. The default priority is [code]1.0[/code].
			</description>
		</method>
		<method name="_get_recognized_extensions" qualifiers="virtual required const">
			<return type="PackedStringArray" />
			<description>
				Gets the list of file extensions to associate with this loader (case-insensitive). e.g. [code]["obj"][/code].
			</description>
		</method>
		<method name="_get_resource_type" qualifiers="virtual required const">
			<return type="String" />
			<description>
				Gets the Godot resource type associated with this loader. e.g. [code]"Mesh"[/code] or [code]"Animation"[/code].
			</description>
		</method>
		<method name="_get_save_extension" qualifiers="virtual required const">
			<return type="String" />
			<description>
				Gets the extension used to save this resource in the [code].godot/imported[/code] directory (see [member ProjectSettings.application/config/use_hidden_project_data_directory]).
			</description>
		</method>
		<method name="_get_visible_name" qualifiers="virtual required const">
			<return type="String" />
			<description>
				Gets the name to display in the import window. You should choose this name as a continuation to "Import as", e.g. "Import as Special Mesh".
			</description>
		</method>
		<method name="_import" qualifiers="virtual required const">
			<return type="int" enum="Error" />
			<param index="0" name="source_file" type="String" />
			<param index="1" name="save_path" type="String" />
			<param index="2" name="options" type="Dictionary" />
			<param index="3" name="platform_variants" type="String[]" />
			<param index="4" name="gen_files" type="String[]" />
			<description>
				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.
			</description>
		</method>
		<method name="append_import_external_resource">
			<return type="int" enum="Error" />
			<param index="0" name="path" type="String" />
			<param index="1" name="custom_options" type="Dictionary" default="{}" />
			<param index="2" name="custom_importer" type="String" default="&quot;&quot;" />
			<param index="3" name="generator_parameters" type="Variant" default="null" />
			<description>
				This function can only be called during the [method _import] callback and it allows manually importing resources from it. This is useful when the imported file generates external resources that require importing (as example, images). Custom parameters for the ".import" file can be passed via the [param custom_options]. Additionally, in cases where multiple importers can handle a file, the [param custom_importer] can be specified to force a specific one. This function performs a resource import and returns immediately with a success or error code. [param generator_parameters] defines optional extra metadata which will be stored as [code skip-lint]generator_parameters[/code] in the [code]remap[/code] section of the [code].import[/code] file, for example to store a md5 hash of the source data.
			</description>
		</method>
	</methods>
</class>
