reckfellENGINE

EditorScenePostImportPlugin

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

On this page
class EditorScenePostImportPluginReckfellSharpEditorInherits RefCounted

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

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.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

EditorScenePostImportPluginConstructor
# EditorScenePostImportPlugin
C#
public EditorScenePostImportPlugin();

Methods11

AddImportOptionvoid
# AddImportOption
C#
public void AddImportOption(string name, Variant value);

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

Parameters
NameTypeDefault
namestring—
valueVariant—
AddImportOptionAdvancedvoid
# AddImportOptionAdvanced
C#
public void AddImportOptionAdvanced(Variant.Type type, string name, Variant defaultValue, PropertyHint hint = PropertyHint.None, string hintString = "", int usageFlags = 6);

Add a specific import option. This function can only be called from EditorScenePostImportPlugin._GetImportOptions and EditorScenePostImportPlugin._GetInternalImportOptions.

Parameters
NameTypeDefault
typeVariant.Type—
namestring—
defaultValueVariant—
hintPropertyHintPropertyHint.None
hintStringstring""
usageFlagsint6
GetOptionValueVariant
# GetOptionValue
C#
public Variant GetOptionValue(StringName name);

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

Parameters
NameTypeDefault
nameStringName—
Returns Variant
_GetImportOptionsvoid
# _GetImportOptions
C#
public virtual void _GetImportOptions(string path);

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

Parameters
NameTypeDefault
pathstring—
_GetInternalImportOptionsvoid
# _GetInternalImportOptions
C#
public virtual void _GetInternalImportOptions(int category);

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

Parameters
NameTypeDefault
categoryint—
_GetInternalOptionUpdateViewRequiredVariant
# _GetInternalOptionUpdateViewRequired
C#
public virtual Variant _GetInternalOptionUpdateViewRequired(int category, string option);

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

Parameters
NameTypeDefault
categoryint—
optionstring—
Returns Variant
_GetInternalOptionVisibilityVariant
# _GetInternalOptionVisibility
C#
public virtual Variant _GetInternalOptionVisibility(int category, bool forAnimation, string option);

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

Parameters
NameTypeDefault
categoryint—
forAnimationbool—
optionstring—
Returns Variant
_GetOptionVisibilityVariant
# _GetOptionVisibility
C#
public virtual Variant _GetOptionVisibility(string path, bool forAnimation, string option);

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

Parameters
NameTypeDefault
pathstring—
forAnimationbool—
optionstring—
Returns Variant
_InternalProcessvoid
# _InternalProcess
C#
public virtual void _InternalProcess(int category, Entity baseNode, Entity node, Resource resource);

Process a specific node or resource for a given category.

Parameters
NameTypeDefault
categoryint—
baseNodeEntity—
nodeEntity—
resourceResource—
_PostProcessvoid
# _PostProcess
C#
public virtual void _PostProcess(Entity scene);

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

Parameters
NameTypeDefault
sceneEntity—
_PreProcessvoid
# _PreProcess
C#
public virtual void _PreProcess(Entity scene);

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

Parameters
NameTypeDefault
sceneEntity—

EditorScenePostImportPlugin.InternalImportCategory

Reckfell Engine documentationBack to top ↑
QUICK LINKSGetting startedEntity hierarchyC# & .NET 10Scenes and prefabs
Reckfell guides and full API K
reckfellENGINE
RECKFELL ACCOUNT

Sign in

Sign in to your Reckfell account.

One account for the entire Reckfell platform.