Table of Contents

Class GDExtensionManager

Provides access to GDExtension functionality.

Inheritance
GDExtensionManager

Remarks

The GDExtensionManager loads, initializes, and keeps track of all available GDExtension libraries in the project.

Note: Do not worry about GDExtension unless you know what you are doing.

See Also

GDExtension overview
GDExtension example in C++

Methods

get_extension(String)

Returns the GDExtension at the given file path, or null if it has not been loaded or does not exist.

GDExtension get_extension(String path)

Parameters

path String

get_loaded_extensions

Qualifiers: const

Returns the file paths of all currently loaded extensions.

PackedStringArray get_loaded_extensions

is_extension_loaded(String)

Qualifiers: const

Returns true if the extension at the given file path has already been loaded successfully. See also get_loaded_extensions.

bool is_extension_loaded(String path)

Parameters

path String

load_extension(String)

Loads an extension by absolute file path. The path needs to point to a valid GDExtension. Returns GDExtensionManager.LOAD_STATUS_OK if successful.

int load_extension(String path)

Parameters

path String

reload_extension(String)

Reloads the extension at the given file path. The path needs to point to a valid GDExtension, otherwise this method may return either GDExtensionManager.LOAD_STATUS_NOT_LOADED or GDExtensionManager.LOAD_STATUS_FAILED.

Note: You can only reload extensions in the editor. In release builds, this method always fails and returns GDExtensionManager.LOAD_STATUS_FAILED.

int reload_extension(String path)

Parameters

path String

unload_extension(String)

Unloads an extension by file path. The path needs to point to an already loaded GDExtension, otherwise this method returns GDExtensionManager.LOAD_STATUS_NOT_LOADED.

int unload_extension(String path)

Parameters

path String

Events

extension_loaded(GDExtension)

Emitted after the editor has finished loading a new extension.

Note: This signal is only emitted in editor builds.

signal extension_loaded(GDExtension extension)

Parameters

extension GDExtension

extension_unloading(GDExtension)

Emitted before the editor starts unloading an extension.

Note: This signal is only emitted in editor builds.

signal extension_unloading(GDExtension extension)

Parameters

extension GDExtension

extensions_reloaded

Emitted after the editor has finished reloading one or more extensions.

signal extensions_reloaded