:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorSceneFormatImporter.xml. .. _class_EditorSceneFormatImporter: EditorSceneFormatImporter ========================= **Inherits:** :ref:`RefCounted` **<** :ref:`Object` **Inherited By:** :ref:`EditorSceneFormatImporterBlend`, :ref:`EditorSceneFormatImporterFBX2GLTF`, :ref:`EditorSceneFormatImporterGLTF`, :ref:`EditorSceneFormatImporterUFBX` Imports scenes from third-parties' 3D files. .. rst-class:: classref-introduction-group Description ----------- **EditorSceneFormatImporter** allows to define an importer script for a third-party 3D format. To use **EditorSceneFormatImporter**, register it using the :ref:`EditorPlugin.add_scene_format_importer_plugin()` method first. .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`_get_extensions`\ (\ ) |virtual| |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_get_import_options`\ (\ path\: :ref:`String`\ ) |virtual| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`_get_option_visibility`\ (\ path\: :ref:`String`, for_animation\: :ref:`bool`, option\: :ref:`String`\ ) |virtual| |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`_import_scene`\ (\ path\: :ref:`String`, flags\: :ref:`int`, options\: :ref:`Dictionary`\ ) |virtual| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_import_option`\ (\ name\: :ref:`String`, value\: :ref:`Variant`\ ) | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_import_option_advanced`\ (\ type\: :ref:`Variant.Type`, name\: :ref:`String`, default_value\: :ref:`Variant`, hint\: :ref:`PropertyHint` = 0, hint_string\: :ref:`String` = "", usage_flags\: :ref:`int` = 6\ ) | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Constants --------- .. _class_EditorSceneFormatImporter_constant_IMPORT_SCENE: .. rst-class:: classref-constant **IMPORT_SCENE** = ``1`` :ref:`🔗` .. container:: contribute There is currently no description for this constant. Please help us by :ref:`contributing one `! .. _class_EditorSceneFormatImporter_constant_IMPORT_ANIMATION: .. rst-class:: classref-constant **IMPORT_ANIMATION** = ``2`` :ref:`🔗` .. container:: contribute There is currently no description for this constant. Please help us by :ref:`contributing one `! .. _class_EditorSceneFormatImporter_constant_IMPORT_FAIL_ON_MISSING_DEPENDENCIES: .. rst-class:: classref-constant **IMPORT_FAIL_ON_MISSING_DEPENDENCIES** = ``4`` :ref:`🔗` .. container:: contribute There is currently no description for this constant. Please help us by :ref:`contributing one `! .. _class_EditorSceneFormatImporter_constant_IMPORT_GENERATE_TANGENT_ARRAYS: .. rst-class:: classref-constant **IMPORT_GENERATE_TANGENT_ARRAYS** = ``8`` :ref:`🔗` .. container:: contribute There is currently no description for this constant. Please help us by :ref:`contributing one `! .. _class_EditorSceneFormatImporter_constant_IMPORT_USE_NAMED_SKIN_BINDS: .. rst-class:: classref-constant **IMPORT_USE_NAMED_SKIN_BINDS** = ``16`` :ref:`🔗` .. container:: contribute There is currently no description for this constant. Please help us by :ref:`contributing one `! .. _class_EditorSceneFormatImporter_constant_IMPORT_DISCARD_MESHES_AND_MATERIALS: .. rst-class:: classref-constant **IMPORT_DISCARD_MESHES_AND_MATERIALS** = ``32`` :ref:`🔗` .. container:: contribute There is currently no description for this constant. Please help us by :ref:`contributing one `! .. _class_EditorSceneFormatImporter_constant_IMPORT_FORCE_DISABLE_MESH_COMPRESSION: .. rst-class:: classref-constant **IMPORT_FORCE_DISABLE_MESH_COMPRESSION** = ``64`` :ref:`🔗` .. container:: contribute There is currently no description for this constant. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_EditorSceneFormatImporter_private_method__get_extensions: .. rst-class:: classref-method :ref:`PackedStringArray` **_get_extensions**\ (\ ) |virtual| |const| :ref:`🔗` Return supported file extensions for this scene importer. .. rst-class:: classref-item-separator ---- .. _class_EditorSceneFormatImporter_private_method__get_import_options: .. rst-class:: classref-method |void| **_get_import_options**\ (\ path\: :ref:`String`\ ) |virtual| :ref:`🔗` Override to add general import options. These will appear in the main import dock on the editor. Add options via :ref:`add_import_option()` and :ref:`add_import_option_advanced()`. \ **Note:** All **EditorSceneFormatImporter** and :ref:`EditorScenePostImportPlugin` instances will add options for all files. It is good practice to check the file extension when ``path`` is non-empty. When the user is editing project settings, ``path`` will be empty. It is recommended to add all options when ``path`` is empty to allow the user to customize Import Defaults. .. rst-class:: classref-item-separator ---- .. _class_EditorSceneFormatImporter_private_method__get_option_visibility: .. rst-class:: classref-method :ref:`Variant` **_get_option_visibility**\ (\ path\: :ref:`String`, for_animation\: :ref:`bool`, option\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` Should return ``true`` to show the given option, ``false`` to hide the given option, or ``null`` to ignore. .. rst-class:: classref-item-separator ---- .. _class_EditorSceneFormatImporter_private_method__import_scene: .. rst-class:: classref-method :ref:`Object` **_import_scene**\ (\ path\: :ref:`String`, flags\: :ref:`int`, options\: :ref:`Dictionary`\ ) |virtual| :ref:`🔗` Perform the bulk of the scene import logic here, for example using :ref:`GLTFDocument` or :ref:`FBXDocument`. .. rst-class:: classref-item-separator ---- .. _class_EditorSceneFormatImporter_method_add_import_option: .. rst-class:: classref-method |void| **add_import_option**\ (\ name\: :ref:`String`, value\: :ref:`Variant`\ ) :ref:`🔗` Add a specific import option (name and default value only). This function can only be called from :ref:`_get_import_options()`. .. rst-class:: classref-item-separator ---- .. _class_EditorSceneFormatImporter_method_add_import_option_advanced: .. rst-class:: classref-method |void| **add_import_option_advanced**\ (\ type\: :ref:`Variant.Type`, name\: :ref:`String`, default_value\: :ref:`Variant`, hint\: :ref:`PropertyHint` = 0, hint_string\: :ref:`String` = "", usage_flags\: :ref:`int` = 6\ ) :ref:`🔗` Add a specific import option. This function can only be called from :ref:`_get_import_options()`. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`