: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/EditorScenePostImportPlugin.xml. .. _class_EditorScenePostImportPlugin: EditorScenePostImportPlugin =========================== **Inherits:** :ref:`RefCounted` **<** :ref:`Object` Plugin to control and modifying the process of importing a scene. .. rst-class:: classref-introduction-group Description ----------- This plugin type exists to modify the process of importing scenes, allowing to change the content as well as add importer options at every stage of the process. .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_get_import_options`\ (\ path\: :ref:`String`\ ) |virtual| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_get_internal_import_options`\ (\ category\: :ref:`int`\ ) |virtual| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`_get_internal_option_update_view_required`\ (\ category\: :ref:`int`, option\: :ref:`String`\ ) |virtual| |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`_get_internal_option_visibility`\ (\ category\: :ref:`int`, for_animation\: :ref:`bool`, option\: :ref:`String`\ ) |virtual| |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`_get_option_visibility`\ (\ path\: :ref:`String`, for_animation\: :ref:`bool`, option\: :ref:`String`\ ) |virtual| |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_internal_process`\ (\ category\: :ref:`int`, base_node\: :ref:`Node`, node\: :ref:`Node`, resource\: :ref:`Resource`\ ) |virtual| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_post_process`\ (\ scene\: :ref:`Node`\ ) |virtual| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_pre_process`\ (\ scene\: :ref:`Node`\ ) |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\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_option_value`\ (\ name\: :ref:`StringName`\ ) |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_EditorScenePostImportPlugin_InternalImportCategory: .. rst-class:: classref-enumeration enum **InternalImportCategory**: :ref:`🔗` .. _class_EditorScenePostImportPlugin_constant_INTERNAL_IMPORT_CATEGORY_NODE: .. rst-class:: classref-enumeration-constant :ref:`InternalImportCategory` **INTERNAL_IMPORT_CATEGORY_NODE** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_EditorScenePostImportPlugin_constant_INTERNAL_IMPORT_CATEGORY_MESH_3D_NODE: .. rst-class:: classref-enumeration-constant :ref:`InternalImportCategory` **INTERNAL_IMPORT_CATEGORY_MESH_3D_NODE** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_EditorScenePostImportPlugin_constant_INTERNAL_IMPORT_CATEGORY_MESH: .. rst-class:: classref-enumeration-constant :ref:`InternalImportCategory` **INTERNAL_IMPORT_CATEGORY_MESH** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_EditorScenePostImportPlugin_constant_INTERNAL_IMPORT_CATEGORY_MATERIAL: .. rst-class:: classref-enumeration-constant :ref:`InternalImportCategory` **INTERNAL_IMPORT_CATEGORY_MATERIAL** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_EditorScenePostImportPlugin_constant_INTERNAL_IMPORT_CATEGORY_ANIMATION: .. rst-class:: classref-enumeration-constant :ref:`InternalImportCategory` **INTERNAL_IMPORT_CATEGORY_ANIMATION** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_EditorScenePostImportPlugin_constant_INTERNAL_IMPORT_CATEGORY_ANIMATION_NODE: .. rst-class:: classref-enumeration-constant :ref:`InternalImportCategory` **INTERNAL_IMPORT_CATEGORY_ANIMATION_NODE** = ``5`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_EditorScenePostImportPlugin_constant_INTERNAL_IMPORT_CATEGORY_SKELETON_3D_NODE: .. rst-class:: classref-enumeration-constant :ref:`InternalImportCategory` **INTERNAL_IMPORT_CATEGORY_SKELETON_3D_NODE** = ``6`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_EditorScenePostImportPlugin_constant_INTERNAL_IMPORT_CATEGORY_MAX: .. rst-class:: classref-enumeration-constant :ref:`InternalImportCategory` **INTERNAL_IMPORT_CATEGORY_MAX** = ``7`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_EditorScenePostImportPlugin_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()`. .. rst-class:: classref-item-separator ---- .. _class_EditorScenePostImportPlugin_private_method__get_internal_import_options: .. rst-class:: classref-method |void| **_get_internal_import_options**\ (\ category\: :ref:`int`\ ) |virtual| :ref:`🔗` Override to add internal import options. These will appear in the 3D scene import dialog. Add options via :ref:`add_import_option()` and :ref:`add_import_option_advanced()`. .. rst-class:: classref-item-separator ---- .. _class_EditorScenePostImportPlugin_private_method__get_internal_option_update_view_required: .. rst-class:: classref-method :ref:`Variant` **_get_internal_option_update_view_required**\ (\ category\: :ref:`int`, option\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` Should return ``true`` if the 3D view of the import dialog needs to update when changing the given option. .. rst-class:: classref-item-separator ---- .. _class_EditorScenePostImportPlugin_private_method__get_internal_option_visibility: .. rst-class:: classref-method :ref:`Variant` **_get_internal_option_visibility**\ (\ category\: :ref:`int`, 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_EditorScenePostImportPlugin_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_EditorScenePostImportPlugin_private_method__internal_process: .. rst-class:: classref-method |void| **_internal_process**\ (\ category\: :ref:`int`, base_node\: :ref:`Node`, node\: :ref:`Node`, resource\: :ref:`Resource`\ ) |virtual| :ref:`🔗` Process a specific node or resource for a given category. .. rst-class:: classref-item-separator ---- .. _class_EditorScenePostImportPlugin_private_method__post_process: .. rst-class:: classref-method |void| **_post_process**\ (\ scene\: :ref:`Node`\ ) |virtual| :ref:`🔗` Post process the scene. This function is called after the final scene has been configured. .. rst-class:: classref-item-separator ---- .. _class_EditorScenePostImportPlugin_private_method__pre_process: .. rst-class:: classref-method |void| **_pre_process**\ (\ scene\: :ref:`Node`\ ) |virtual| :ref:`🔗` Pre Process the scene. This function is called right after the scene format loader loaded the scene and no changes have been made. Pre process may be used to adjust internal import options in the ``"nodes"``, ``"meshes"``, ``"animations"`` or ``"materials"`` keys inside ``get_option_value("_subresources")``. .. rst-class:: classref-item-separator ---- .. _class_EditorScenePostImportPlugin_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()` and :ref:`_get_internal_import_options()`. .. rst-class:: classref-item-separator ---- .. _class_EditorScenePostImportPlugin_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()` and :ref:`_get_internal_import_options()`. .. rst-class:: classref-item-separator ---- .. _class_EditorScenePostImportPlugin_method_get_option_value: .. rst-class:: classref-method :ref:`Variant` **get_option_value**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Query the value of an option. This function can only be called from those querying visibility, or processing. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |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.)`