GDExtension

Documentation

Overview

Package GDExtension provides methods for working with GDExtension object instances.

Index

• func LibraryPath() string
• type Advanced
• type Any
• type InitializationLevel
• type Instance
  • func New() Instance
  • func (self Instance) AsGDExtension() Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self Instance) AsResource() Resource.Instance
  • func (self Instance) GetMinimumLibraryInitializationLevel() gd.GDExtensionInitializationLevel
  • func (self Instance) IsLibraryOpen() bool
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value

Functions

func LibraryPath

func LibraryPath() string

LibraryPath is the path to the shared library that contains the current GD extension.

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
	AsGDExtension() Instance
}

type InitializationLevel

type InitializationLevel = gdclass.GDExtensionInitializationLevel //gd:GDExtension.InitializationLevel

const (
	/*The library is initialized at the same time as the core features of the engine.*/
	InitializationLevelCore InitializationLevel = 0
	/*The library is initialized at the same time as the engine's servers (such as [RenderingServer] or [PhysicsServer3D]).*/
	InitializationLevelServers InitializationLevel = 1
	/*The library is initialized at the same time as the engine's scene-related classes.*/
	InitializationLevelScene InitializationLevel = 2
	/*The library is initialized at the same time as the engine's editor classes. Only happens when loading the GDExtension in the editor.*/
	InitializationLevelEditor InitializationLevel = 3
)

type Instance

type Instance [1]gdclass.GDExtension

The [GDExtension] resource type represents a [url=https://en.wikipedia.org/wiki/Shared_library]shared library[/url] which can expand the functionality of the engine. The [GDExtensionManager] singleton is responsible for loading, reloading, and unloading [GDExtension] resources. [b]Note:[/b] GDExtension itself is not a scripting language and has no relation to [GDScript] resources.

var Nil Instance

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

func New

func New() Instance

func (Instance) AsGDExtension

func (self Instance) AsGDExtension() Instance

func (Instance) AsObject

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

func (Instance) AsRefCounted

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

func (Instance) AsResource

func (self Instance) AsResource() Resource.Instance

func (Instance) GetMinimumLibraryInitializationLevel

func (self Instance) GetMinimumLibraryInitializationLevel() gd.GDExtensionInitializationLevel

Returns the lowest level required for this extension to be properly initialized (see the [enum InitializationLevel] enum).

func (Instance) IsLibraryOpen

func (self Instance) IsLibraryOpen() bool

Returns [code]true[/code] if this extension's library has been opened.

func (*Instance) UnsafePointer

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

func (Instance) Virtual

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