Class PluginManager

Game and Editor plugins management service.

Inheritance

System.Object

PluginManager

Namespace: FlaxEngine

Assembly: FlaxEngine.CSharp.dll

Syntax

[Unmanaged]
public static class PluginManager : Object

Properties

EditorPlugins

Gets the editor plugins.

Declaration

[Unmanaged]
public static Plugin[] EditorPlugins { get; }

Property Value

Plugin[]

GamePlugins

Gets the game plugins.

Declaration

[Unmanaged]
public static GamePlugin[] GamePlugins { get; }

Property Value

GamePlugin[]

Methods

GetPlugin(String)

Return the first plugin using the provided name.

Declaration

[Unmanaged]
public static Plugin GetPlugin(string name)

Parameters

System.String name The plugin name.

Returns

Plugin The plugin, or null if not loaded.

GetPlugin(Type)

Returns the first plugin of the provided type.

Declaration

[Unmanaged]
public static Plugin GetPlugin([TypeReference] Type type)

Parameters

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

Returns

Plugin The plugin or null.

GetPlugin<T>()

Returns the first plugin of the provided type.

Declaration

public static T GetPlugin<T>()
    where T : Plugin

Returns

T The plugin, or null if not loaded.

Type Parameters

T The plugin type.

Events

PluginLoaded

Occurs when plugin gets loaded and initialized.

Declaration

[Unmanaged]
public static event Action<Plugin> PluginLoaded

Event Type

System.Action<Plugin>

PluginLoading

Occurs before loading plugin.

Declaration

[Unmanaged]
public static event Action<Plugin> PluginLoading

Event Type

System.Action<Plugin>

PluginsChanged

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

Declaration

[Unmanaged]
public static event Action PluginsChanged

Event Type

System.Action

PluginUnloaded

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

Declaration

[Unmanaged]
public static event Action<Plugin> PluginUnloaded

Event Type

System.Action<Plugin>

PluginUnloading

Occurs before unloading plugin.

Declaration

[Unmanaged]
public static event Action<Plugin> PluginUnloading

Event Type

System.Action<Plugin>