EditorScenePostImportPlugin

Inherits: RefCounted < Object

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

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.

Methods

void

_get_import_options ( String path ) virtual

void

_get_internal_import_options ( int category ) virtual

Variant

_get_internal_option_update_view_required ( int category, String option ) virtual const

Variant

_get_internal_option_visibility ( int category, String option ) virtual const

Variant

_get_option_visibility ( String path, String option ) virtual const

void

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

void

_post_process ( Node scene ) virtual

void

_pre_process ( Node scene ) virtual

void

add_import_option ( String name, Variant value )

void

add_import_option_advanced ( Variant.Type type, String name, Variant default_value, PropertyHint hint=0, String hint_string="", int usage_flags=7 )

Variant

get_option_value ( StringName name ) const

Enumerations

enum InternalImportCategory:

  • INTERNAL_IMPORT_CATEGORY_NODE = 0

  • INTERNAL_IMPORT_CATEGORY_MESH_3D_NODE = 1

  • INTERNAL_IMPORT_CATEGORY_MESH = 2

  • INTERNAL_IMPORT_CATEGORY_MATERIAL = 3

  • INTERNAL_IMPORT_CATEGORY_ANIMATION = 4

  • INTERNAL_IMPORT_CATEGORY_ANIMATION_NODE = 5

  • INTERNAL_IMPORT_CATEGORY_MAX = 6

Method Descriptions

  • void _get_import_options ( String path ) virtual

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


  • void _get_internal_import_options ( int category ) virtual

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


  • Variant _get_internal_option_update_view_required ( int category, String option ) virtual const

Return true whether updating the 3D view of the import dialog needs to be updated if an option has changed.


  • Variant _get_internal_option_visibility ( int category, String option ) virtual const

Return true or false whether a given option should be visible. Return null to ignore.


Return true or false whether a given option should be visible. Return null to ignore.


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

Process a specific node or resource for a given category.


  • void _post_process ( Node scene ) virtual

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


  • void _pre_process ( Node scene ) virtual

Pre Process the scene. This function is called right after the scene format loader loaded the scene and no changes have been made.


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


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


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