EditorResourceConversionPlugin

Documentation

Overview

Package EditorResourceConversionPlugin provides methods for working with EditorResourceConversionPlugin object instances.

Index

• type Advanced
• type Any
• type Implementation
• type Instance
  • func New() Instance
  • func (self Instance) AsEditorResourceConversionPlugin() Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value
• type Interface

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any

type Any interface {
	gd.IsClass
	AsEditorResourceConversionPlugin() Instance
}

type Implementation

type Implementation = implementation

Implementation implements Interface with empty methods.

type Instance

type Instance [1]gdclass.EditorResourceConversionPlugin

[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]. [codeblocks] [gdscript] extends EditorResourceConversionPlugin

func _handles(resource: Resource):

return resource is ImageTexture

func _converts_to():

return "PortableCompressedTexture2D"

func _convert(itex: Resource):

var ptex = PortableCompressedTexture2D.new()
ptex.create_from_image(itex.get_image(), PortableCompressedTexture2D.COMPRESSION_MODE_LOSSLESS)
return ptex

[/gdscript] [/codeblocks] To use an [EditorResourceConversionPlugin], register it using the [method EditorPlugin.add_resource_conversion_plugin] method first.

See [Interface] for methods that can be overridden by a [Class] that extends it.

%!(EXTRA string=EditorResourceConversionPlugin)

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AsEditorResourceConversionPlugin

func (self Instance) AsEditorResourceConversionPlugin() Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

type Interface

type Interface interface {
	//Returns the class name of the target type of [Resource] that this plugin converts source resources to.
	ConvertsTo() string
	//Called to determine whether a particular [Resource] can be converted to the target resource type by this plugin.
	Handles(resource [1]gdclass.Resource) bool
	//Takes an input [Resource] and converts it to the type given in [method _converts_to]. The returned [Resource] is the result of the conversion, and the input [Resource] remains unchanged.
	Convert(resource [1]gdclass.Resource) [1]gdclass.Resource
}