From 9676650f2f7943ebbf9363fa65e47be62fb22164 Mon Sep 17 00:00:00 2001 From: Ryan Roden-Corrent Date: Tue, 9 Feb 2021 08:30:27 -0500 Subject: [PATCH] Clarify EditorImportPlugin.get_visible_name. According to the docs at https://docs.godotengine.org/en/stable/tutorials/plugins/editor/import_plugins.html#the-editorimportplugin-class > The get_visible_name() method is responsible for returning the name of > the type it imports and it will be shown to the user in the Import dock. > You should choose this name as a continuation to "Import as", e.g. > "Import as Silly Material" I've verified Godot's behavior reflects this, so the code examples should reflect this. Also document propagating save error in EditorImportPlugin. It seems that the suggested code ignores any error from `ResourceSaver.save`, but I think we should return it. --- doc/classes/EditorImportPlugin.xml | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/doc/classes/EditorImportPlugin.xml b/doc/classes/EditorImportPlugin.xml index e5401134bf7..aa64ab40436 100644 --- a/doc/classes/EditorImportPlugin.xml +++ b/doc/classes/EditorImportPlugin.xml @@ -16,7 +16,7 @@ return "my.special.plugin" func get_visible_name(): - return "Special Mesh Importer" + return "Special Mesh" func get_recognized_extensions(): return ["special", "spec"] @@ -44,8 +44,7 @@ # Fill the Mesh with data read in "file", left as an exercise to the reader. var filename = save_path + "." + get_save_extension() - ResourceSaver.save(filename, mesh) - return OK + return ResourceSaver.save(filename, mesh) [/gdscript] [csharp] using Godot; @@ -60,7 +59,7 @@ public override String GetVisibleName() { - return "Special Mesh Importer"; + return "Special Mesh"; } public override Godot.Collections.Array GetRecognizedExtensions() @@ -104,8 +103,7 @@ var mesh = new ArrayMesh(); // Fill the Mesh with data read in "file", left as an exercise to the reader. String filename = savePath + "." + GetSaveExtension(); - ResourceSaver.Save(filename, mesh); - return (int)Error.Ok; + return (int)ResourceSaver.Save(filename, mesh); } } [/csharp] @@ -220,7 +218,7 @@ - Gets the name to display in the import window. + 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".