EditorImportPlugin

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

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.addImportPlugin. EditorImportPlugins work by associating with specific file extensions and a resource type. See getRecognizedExtension and getResourceType). They may optionally specify some import presets that affect the import process. EditorImportPlugins are responsible for creating the resources and saving them in the .import directory. Below is an example EditorImportPlugin that imports a Mesh from a file with the extension ".special" or ".spec":

More...

Members

Aliases

BaseClasses
alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses)
Undocumented in source.

Functions

_import
long _import(StringArg0 source_file, StringArg1 save_path, Dictionary options, Array r_platform_variants, Array r_gen_files)
getImportOptions
Array getImportOptions(long preset)

Get 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).

getImportOrder
long getImportOrder()

Get the order of this importer to be run when importing resources. Higher values will be called later. Use this to ensure the importer runs after the dependencies are already imported.

getImporterName
String getImporterName()

Get the unique name of the importer.

getOptionVisibility
bool getOptionVisibility(StringArg0 option, Dictionary options)
getPresetCount
long getPresetCount()

Get the number of initial presets defined by the plugin. Use getImportOptions to get the default options for the preset and getPresetName to get the name of the preset.

getPresetName
String getPresetName(long preset)

Get the name of the options preset at this index.

getPriority
double getPriority()

Get the priority of this plugin for the recognized extension. Higher priority plugins will be preferred. Default value is 1.0.

getRecognizedExtensions
Array getRecognizedExtensions()

Get the list of file extensions to associate with this loader (case insensitive). e.g. "obj".

getResourceType
String getResourceType()

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

getSaveExtension
String getSaveExtension()

Get the extension used to save this resource in the .import directory.

getVisibleName
String getVisibleName()

Get the name to display in the import window.

opAssign
EditorImportPlugin opAssign(T n)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(EditorImportPlugin other)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(typeof(null) n)
Undocumented in source. Be warned that the author may not have intended to support it.

Mixins

__anonymous
mixin baseCasts
Undocumented in source.

Static functions

_new
EditorImportPlugin _new()
Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized
bool _classBindingInitialized;
Undocumented in source.

Structs

_classBinding
struct _classBinding
Undocumented in source.

Unions

__anonymous
union __anonymous
Undocumented in source.

Variables

_GODOT_internal_name
enum string _GODOT_internal_name;
Undocumented in source.

Mixed In Members

From mixin baseCasts

as
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
ToRef as()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(ToRef)
Undocumented in source.
opCast
void* opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
godot_object opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
bool opCast()
Undocumented in source. Be warned that the author may not have intended to support it.

Detailed Description

tool extends EditorImportPlugin

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

func get_visible_name(): return "Special Mesh Importer"

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, r_platform_variants, r_gen_files): var file = File.new() if file.open(source_file, File.READ) != OK: return FAILED

var mesh = Mesh.new() # Fill the Mesh with data read in 'file', left as exercise to the reader

var filename = save_path + "." + get_save_extension() ResourceSaver.save(filename, mesh) return OK

Meta