Class PluginManager

Game and Editor plugins management service.

Inheritance

PluginManager

Assembly: FlaxEngine.dll

File: Engine/Scripting/Plugins/PluginManager.h

Syntax

public class PluginManager

Fields

PluginLoaded

Occurs when plugin gets loaded and initialized.

Declaration

public static Delegate<Plugin* > PluginLoaded

Field Value

Delegate<Plugin >

PluginLoading

Occurs before loading plugin.

Declaration

public static Delegate<Plugin* > PluginLoading

Field Value

Delegate<Plugin >

PluginsChanged

Occurs when plugins collection gets edited (added or removed plugin).

Declaration

public static Action PluginsChanged

Field Value

Action

PluginUnloaded

Occurs when plugin gets unloaded. It should not be used anymore.

Declaration

public static Delegate<Plugin* > PluginUnloaded

Field Value

Delegate<Plugin >

PluginUnloading

Occurs before unloading plugin.

Declaration

public static Delegate<Plugin* > PluginUnloading

Field Value

Delegate<Plugin >

Methods

GetEditorPlugins()

Gets the editor plugins.

Declaration

public static Array<Plugin* > GetEditorPlugins()

Returns

Array<Plugin >

GetGamePlugins()

Gets the game plugins.

Declaration

public static Array<GamePlugin* > GetGamePlugins()

Returns

Array<GamePlugin >

GetPlugin()

Returns the first plugin of the provided type.

Declaration

public static T* GetPlugin()

Returns

T The plugin or null.

Type Parameters

typename T

GetPlugin(const MClass* type)

Returns the first plugin of the provided type.

Declaration

public static Plugin* GetPlugin(const MClass* type)

Parameters

MClass type Type of the plugin to search for. Includes any plugin base class derived from the type.

Returns

Plugin The plugin or null.

GetPlugin(const ScriptingTypeHandle& type)

Returns the first plugin of the provided type.

Declaration

public static Plugin* GetPlugin(const ScriptingTypeHandle& type)

Parameters

ScriptingTypeHandle type Type of the plugin to search for. Includes any plugin base class derived from the type.

Returns

Plugin The plugin or null.

GetPlugin(const StringView& name)

Return the first plugin using the provided name.

Declaration

public static Plugin* GetPlugin(const StringView& name)

Parameters

StringView name

Returns

Plugin The plugin, or null if not loaded.