EditorImportPlugin

Inherits: ResourceImporter < RefCounted < Object

Registers a custom resource importer in the editor. Use the class to parse any file and import it as a new resource type.

Description

EditorImportPlugins 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. Register your EditorPlugin with EditorPlugin.add_import_plugin.

EditorImportPlugins work by associating with specific file extensions and a resource type. See _get_recognized_extensions and _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 .godot/imported directory.

Below is an example EditorImportPlugin that imports a Mesh from a file with the extension ".special" or ".spec":

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(i):
    return "Default"

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

func _import(source_file, save_path, options, platform_variants, gen_files):
    var file = File.new()
    if file.open(source_file, File.READ) != OK:
        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(filename, mesh)

Tutorials

Methods

Array

_get_import_options ( int preset_index ) virtual const

int

_get_import_order ( ) virtual const

String

_get_importer_name ( ) virtual const

bool

_get_option_visibility ( StringName option_name, Dictionary options ) virtual const

int

_get_preset_count ( ) virtual const

String

_get_preset_name ( int preset_index ) virtual const

float

_get_priority ( ) virtual const

PackedStringArray

_get_recognized_extensions ( ) virtual const

String

_get_resource_type ( ) virtual const

String

_get_save_extension ( ) virtual const

String

_get_visible_name ( ) virtual const

int

_import ( String source_file, String save_path, Dictionary options, Array platform_variants, Array gen_files ) virtual const

Method Descriptions

  • Array _get_import_options ( int preset_index ) virtual const

Gets the options and default values for the preset at this index. Returns an Array of Dictionaries with the following keys: name, default_value, property_hint (optional), hint_string (optional), usage (optional).


  • int _get_import_order ( ) virtual const

Gets the order of this importer to be run when importing resources. Importers with lower 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 0 unless overridden by a specific importer. See ImportOrder for some predefined values.


  • String _get_importer_name ( ) virtual const

Gets the unique name of the importer.


This method can be overridden to hide specific import options if conditions are met. This is mainly useful for hiding options that depend on others if one of them is disabled. For example:

func _get_option_visibility(option, options):
    # Only show the lossy quality setting if the compression mode is set to "Lossy".
    if option == "compress/lossy_quality" and options.has("compress/mode"):
        return int(options["compress/mode"]) == COMPRESS_LOSSY # This is a constant that you set

    return true

Return true to make all options always visible.


  • int _get_preset_count ( ) virtual const

Gets the number of initial presets defined by the plugin. Use _get_import_options to get the default options for the preset and _get_preset_name to get the name of the preset.


  • String _get_preset_name ( int preset_index ) virtual const

Gets the name of the options preset at this index.


  • float _get_priority ( ) virtual const

Gets the priority of this plugin for the recognized extension. Higher priority plugins will be preferred. The default priority is 1.0.


Gets the list of file extensions to associate with this loader (case-insensitive). e.g. ["obj"].


  • String _get_resource_type ( ) virtual const

Gets the Godot resource type associated with this loader. e.g. "Mesh" or "Animation".


  • String _get_save_extension ( ) virtual const

Gets the extension used to save this resource in the .godot/imported directory.


  • String _get_visible_name ( ) virtual const

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".


Imports source_file into save_path with the import options specified. The platform_variants and gen_files arrays will be modified by this function.

This method must be overridden to do the actual importing work. See this class' description for an example of overriding this method.