Class EditorScenePostImportPlugin

Plugin to control and modifying the process of importing a scene.

Inheritance

RefCounted

Object

EditorScenePostImportPlugin

Remarks

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.

Methods

_get_import_options(String)

Qualifiers: virtual

Override to add general import options. These will appear in the main import dock on the editor. Add options via EditorScenePostImportPlugin.add_import_option and EditorScenePostImportPlugin.add_import_option_advanced.

void _get_import_options(String path)

Parameters

path String

_get_internal_import_options(int)

Qualifiers: virtual

Override to add internal import options. These will appear in the 3D scene import dialog. Add options via EditorScenePostImportPlugin.add_import_option and EditorScenePostImportPlugin.add_import_option_advanced.

void _get_internal_import_options(int category)

Parameters

category int

_get_internal_option_update_view_required(int, String)

Qualifiers: virtualconst

Should return true if the 3D view of the import dialog needs to update when changing the given option.

Variant _get_internal_option_update_view_required(int category, String option)

Parameters

category int

option String

_get_internal_option_visibility(int, bool, String)

Qualifiers: virtualconst

Should return true to show the given option, false to hide the given option, or null to ignore.

Variant _get_internal_option_visibility(int category, bool for_animation, String option)

Parameters

category int

for_animation bool

option String

_get_option_visibility(String, bool, String)

Qualifiers: virtualconst

Should return true to show the given option, false to hide the given option, or null to ignore.

Variant _get_option_visibility(String path, bool for_animation, String option)

Parameters

path String

for_animation bool

option String

_internal_process(int, Node, Node, Resource)

Qualifiers: virtual

Process a specific node or resource for a given category.

void _internal_process(int category, Node base_node, Node node, Resource resource)

Parameters

category int

base_node Node

node Node

resource Resource

_post_process(Node)

Qualifiers: virtual

Post process the scene. This function is called after the final scene has been configured.

void _post_process(Node scene)

Parameters

scene Node

_pre_process(Node)

Qualifiers: virtual

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

void _pre_process(Node scene)

Parameters

scene Node

add_import_option(String, Variant)

Add a specific import option (name and default value only). This function can only be called from EditorScenePostImportPlugin._get_import_options and EditorScenePostImportPlugin._get_internal_import_options.

void add_import_option(String name, Variant value)

Parameters

name String

value Variant

add_import_option_advanced(int, String, Variant, int, String, int)

Add a specific import option. This function can only be called from EditorScenePostImportPlugin._get_import_options and EditorScenePostImportPlugin._get_internal_import_options.

void add_import_option_advanced(int type, String name, Variant default_value, int hint, String hint_string, int usage_flags)

Parameters

type int

name String

default_value Variant

hint int

hint_string String

usage_flags int

get_option_value(StringName)

Qualifiers: const

Query the value of an option. This function can only be called from those querying visibility, or processing.

Variant get_option_value(StringName name)

Parameters

name StringName