ResourceImporter

package
v0.0.0-...-0d6c339 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 16, 2025 License: MIT Imports: 22 Imported by: 0

Documentation

Overview

This is the base class for Godot's resource importers. To implement your own resource importers using editor plugins, see graphics.gd/classdb/EditorImportPlugin.

Index

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 Any

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

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

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]See Interface for methods that can be overridden by T.

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsRefCounted

func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted

func (*Extension[T]) AsResourceImporter

func (self *Extension[T]) AsResourceImporter() Instance

type ID

type ID Object.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.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

type Implementation

type Implementation = implementation

Implementation implements Interface with empty methods.

type ImportOrder

type ImportOrder int //gd:ResourceImporter.ImportOrder
const (
	// The default import order.
	ImportOrderDefault ImportOrder = 0
	// The import order for scenes, which ensures scenes are imported after all other core resources such as textures. Custom importers should generally have an import order lower than 100 to avoid issues when importing scenes that rely on custom resources.
	ImportOrderScene ImportOrder = 100
)

type Instance

type Instance [1]gdclass.ResourceImporter

Instance of the class with convieniently typed arguments and results.

var Nil Instance

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

func New

func New() Instance

func (Instance) AsObject

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

func (Instance) AsRefCounted

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

func (Instance) AsResourceImporter

func (self Instance) AsResourceImporter() Instance

func (Instance) ID

func (self Instance) ID() ID

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) Virtual

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

type Interface

type Interface interface {
	// Called when the engine compilation profile editor wants to check what build options an imported resource needs. For example, [graphics.gd/classdb/ResourceImporterDynamicFont] has a property called [graphics.gd/classdb/ResourceImporterDynamicFont.Instance.MultichannelSignedDistanceField], that depends on the engine to be build with the "msdfgen" module. If that resource happened to be a custom one, it would be handled like this:
	//
	//
	//
	// func _get_build_dependencies(path):
	//
	// 	var resource = load(path)
	//
	// 	var dependencies = PackedStringArray()
	//
	//
	//
	// 	if resource.multichannel_signed_distance_field:
	//
	// 		dependencies.push_back("module_msdfgen_enabled")
	//
	//
	//
	// 	return dependencies
	//
	//
	GetBuildDependencies(path string) []string
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL