EditorResourceConversionPlugin

Plugin for adding custom converters from one resource format to another in the editor resource picker context menu; for example, converting a StandardMaterial3D to a [ShaderMaterial](/en/docs/api/shadermat

1.0.0

class EditorResourceConversionPluginReckfellSharpEditorInherits RefCounted

Plugin for adding custom converters from one resource format to another in the editor resource picker context menu; for example, converting a StandardMaterial3D to a ShaderMaterial.

EditorResourceConversionPlugin is invoked when the context menu is brought up for a resource in the editor inspector. Relevant conversion plugins will appear as menu options to convert the given resource to a target type. Below shows an example of a basic plugin that will convert an ImageTexture to a PortableCompressedTexture2D.

To use an EditorResourceConversionPlugin, register it using the EditorPlugin.AddResourceConversionPlugin method first.

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

Constructors1

EditorResourceConversionPluginConstructor

# EditorResourceConversionPlugin

C#
public EditorResourceConversionPlugin();

Methods3

_ConvertResource

# _Convert

public virtual Resource _Convert(Resource resource);

Takes an input Resource and converts it to the type given in EditorResourceConversionPlugin._ConvertsTo. The returned Resource is the result of the conversion, and the input Resource remains unchanged.

Parameters
Name	Type	Default
`resource`	`Resource`	—

Returns Resource

_ConvertsTostring

# _ConvertsTo

C#
public virtual string _ConvertsTo();

Returns the class name of the target type of Resource that this plugin converts source resources to.

Returns string

_Handlesbool

# _Handles

C#
public virtual bool _Handles(Resource resource);

Called to determine whether a particular Resource can be converted to the target resource type by this plugin.

Parameters
Name	Type	Default
`resource`	`Resource`	—

Returns bool

Reckfell Engine documentationBack to top ↑