Documentation
¶
Overview ¶
[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].
package main
import (
"graphics.gd/classdb/EditorResourceConversionPlugin"
"graphics.gd/classdb/ImageTexture"
"graphics.gd/classdb/PortableCompressedTexture2D"
"graphics.gd/classdb/Resource"
"graphics.gd/variant/Object"
)
type ExampleEditorResourceConversionPlugin struct {
EditorResourceConversionPlugin.Extension[ExampleEditorResourceConversionPlugin]
}
func (e *ExampleEditorResourceConversionPlugin) Handles(resource Resource.Instance) bool {
return Object.Is[ImageTexture.Instance](resource)
}
func (e *ExampleEditorResourceConversionPlugin) ConvertsTo() string {
return "PortableCompressedTexture2D"
}
func (e *ExampleEditorResourceConversionPlugin) Convert(itex Resource.Instance) Resource.Instance {
var ptex = PortableCompressedTexture2D.New()
ptex.CreateFromImage(Object.To[ImageTexture.Instance](itex).AsTexture2D().GetImage(), PortableCompressedTexture2D.CompressionModeLossless)
return ptex.AsResource()
}
To use an [EditorResourceConversionPlugin], register it using the [Instance.Editorplugin.AddResourceConversionPlugin] method first.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Implementation
- type Instance
- func (self Instance) AsEditorResourceConversionPlugin() Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) ID() ID
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) Virtual(name string) reflect.Value
- type Interface
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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 Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsEditorResourceConversionPlugin ¶
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Implementation ¶
type Implementation = implementation
Implementation implements Interface with empty methods.
type Instance ¶
type Instance [1]gdclass.EditorResourceConversionPlugin
Instance of the class with convieniently typed arguments and results. See Interface for methods that can be overridden by a [Class] that extends it.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsEditorResourceConversionPlugin ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
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 Resource.Instance) 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 Resource.Instance) Resource.Instance
}
Source Files