Class PluginManager

The manager class for all plugins.

Inheritance

Object

PluginManager

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: IPA.Loader

Assembly: IPA.Loader.dll

Syntax

public static class PluginManager

Properties

AllPlugins

Gets a list of all enabled BSIPA plugins.

Declaration

public static IEnumerable<PluginMetadata> AllPlugins { get; }

Property Value

Type	Description
IEnumerable<PluginMetadata>	a collection of all enabled plugins as PluginMetadatas

DisabledPlugins

Gets a list of disabled BSIPA plugins.

Declaration

public static IEnumerable<PluginMetadata> DisabledPlugins { get; }

Property Value

Type	Description
IEnumerable<PluginMetadata>	a collection of all disabled plugins as PluginMetadata

Plugins

An IEnumerable<T> of old IPA plugins.

Declaration

[Obsolete("I mean, IPlugin shouldn't be used, so why should this? Not renaming to extend support for old plugins.")]
public static IEnumerable<IPlugin> Plugins { get; }

Property Value

Type	Description
IEnumerable<IPlugin>	all legacy plugin instances

Methods

GetDisabledPlugin(String)

Gets a disabled plugin's metadata by its name.

Declaration

public static PluginMetadata GetDisabledPlugin(string name)

Parameters

Type	Name	Description
String	name	the name of the disabled plugin to get

Returns

Type	Description
PluginMetadata	the metadata for the corresponding plugin

GetDisabledPluginFromId(String)

Gets a disabled plugin's metadata by its ID.

Declaration

public static PluginMetadata GetDisabledPluginFromId(string name)

Parameters

Type	Name	Description
String	name	the ID of the disabled plugin to get

Returns

Type	Description
PluginMetadata	the metadata for the corresponding plugin

GetPlugin(String)

Gets info about the enabled plugin with the specified name.

Declaration

public static PluginMetadata GetPlugin(string name)

Parameters

Type	Name	Description
String	name	the name of the plugin to get (must be an exact match)

Returns

Type	Description
PluginMetadata	the plugin metadata for the requested plugin or null if it doesn't exist or is disabled

GetPluginFromId(String)

Gets info about the enabled plugin with the specified ID.

Declaration

public static PluginMetadata GetPluginFromId(string name)

Parameters

Type	Name	Description
String	name	the ID name of the plugin to get (must be an exact match)

Returns

Type	Description
PluginMetadata	the plugin metadata for the requested plugin or null if it doesn't exist or is disabled

IsDisabled(PluginMetadata)

Checks if a given plugin is disabled.

Declaration

public static bool IsDisabled(PluginMetadata meta)

Parameters

Type	Name	Description
PluginMetadata	meta	the plugin to check

Returns

Type	Description
Boolean	true if the plugin is disabled, false otherwise.

IsEnabled(PluginMetadata)

Checks if a given plugin is enabled.

Declaration

public static bool IsEnabled(PluginMetadata meta)

Parameters

Type	Name	Description
PluginMetadata	meta	the plugin to check

Returns

Type	Description
Boolean	true if the plugin is enabled, false otherwise.

PluginStateTransaction()

Creates a new transaction for mod enabling and disabling mods simultaneously.

Declaration

public static StateTransitionTransaction PluginStateTransaction()

Returns

Type	Description
StateTransitionTransaction	a new StateTransitionTransaction that captures the current state of loaded mods

Events

PluginDisabled

Called whenever a plugin is disabled.

Declaration

public static event PluginManager.PluginDisableDelegate PluginDisabled

Event Type

Type	Description
PluginManager.PluginDisableDelegate

PluginEnabled

Called whenever a plugin is enabled.

Declaration

public static event PluginManager.PluginEnableDelegate PluginEnabled

Event Type

Type	Description
PluginManager.PluginEnableDelegate