You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 

794 lines
41 KiB

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class PluginManager
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class PluginManager
">
<meta name="generator" content="docfx 2.48.0.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<link rel="stylesheet" href="../styles/fix.css">
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="../">
<meta property="docfx:newtab" content="true">
</head> <body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list"></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="IPA.Loader.PluginManager">
<h1 id="IPA_Loader_PluginManager" data-uid="IPA.Loader.PluginManager" class="text-break">Class PluginManager
</h1>
<div class="markdown level0 summary"><p>The manager class for all plugins.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
<div class="level1"><span class="xref">PluginManager</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#System_Object_ToString">Object.ToString()</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_">Object.Equals(Object)</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_System_Object_">Object.Equals(Object, Object)</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.referenceequals#System_Object_ReferenceEquals_System_Object_System_Object_">Object.ReferenceEquals(Object, Object)</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#System_Object_GetHashCode">Object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#System_Object_GetType">Object.GetType()</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#System_Object_MemberwiseClone">Object.MemberwiseClone()</a>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="IPA.Loader.html">IPA.Loader</a></h6>
<h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
<h5 id="IPA_Loader_PluginManager_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static class PluginManager</code></pre>
</div>
<h3 id="properties">Properties
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginManager_AllPlugins.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginManager.AllPlugins%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/a02c1e05d53c69a17f076b09be59aa0b4e554635/IPA.Loader/Loader/PluginManager.cs/#L294">View Source</a>
</span>
<a id="IPA_Loader_PluginManager_AllPlugins_" data-uid="IPA.Loader.PluginManager.AllPlugins*"></a>
<h4 id="IPA_Loader_PluginManager_AllPlugins" data-uid="IPA.Loader.PluginManager.AllPlugins">AllPlugins</h4>
<div class="markdown level1 summary"><p>Gets a list of all enabled BSIPA plugins. Use <a class="xref" href="IPA.Loader.PluginManager.html#IPA_Loader_PluginManager_EnabledPlugins">EnabledPlugins</a> instead of this.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Obsolete(&quot;This is an old name that no longer accurately represents its value. Use EnabledPlugins instead.&quot;)]
public static IEnumerable&lt;PluginMetadata&gt; AllPlugins { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a>&gt;</td>
<td><p>a collection of all enabled plugins as <a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a>s</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginManager_DisabledPlugins.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginManager.DisabledPlugins%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/a02c1e05d53c69a17f076b09be59aa0b4e554635/IPA.Loader/Loader/PluginManager.cs/#L305">View Source</a>
</span>
<a id="IPA_Loader_PluginManager_DisabledPlugins_" data-uid="IPA.Loader.PluginManager.DisabledPlugins*"></a>
<h4 id="IPA_Loader_PluginManager_DisabledPlugins" data-uid="IPA.Loader.PluginManager.DisabledPlugins">DisabledPlugins</h4>
<div class="markdown level1 summary"><p>Gets a list of disabled BSIPA plugins.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;PluginMetadata&gt; DisabledPlugins { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a>&gt;</td>
<td><p>a collection of all disabled plugins as <a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginManager_EnabledPlugins.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginManager.EnabledPlugins%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/a02c1e05d53c69a17f076b09be59aa0b4e554635/IPA.Loader/Loader/PluginManager.cs/#L300">View Source</a>
</span>
<a id="IPA_Loader_PluginManager_EnabledPlugins_" data-uid="IPA.Loader.PluginManager.EnabledPlugins*"></a>
<h4 id="IPA_Loader_PluginManager_EnabledPlugins" data-uid="IPA.Loader.PluginManager.EnabledPlugins">EnabledPlugins</h4>
<div class="markdown level1 summary"><p>Gets a collection of all enabled plugins, as represented by <a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;PluginMetadata&gt; EnabledPlugins { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a>&gt;</td>
<td><p>a collection of all enabled plugins</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginManager_IgnoredPlugins.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginManager.IgnoredPlugins%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/a02c1e05d53c69a17f076b09be59aa0b4e554635/IPA.Loader/Loader/PluginManager.cs/#L312">View Source</a>
</span>
<a id="IPA_Loader_PluginManager_IgnoredPlugins_" data-uid="IPA.Loader.PluginManager.IgnoredPlugins*"></a>
<h4 id="IPA_Loader_PluginManager_IgnoredPlugins" data-uid="IPA.Loader.PluginManager.IgnoredPlugins">IgnoredPlugins</h4>
<div class="markdown level1 summary"><p>Gets a read-only dictionary of an ignored plugin to the reason it was ignored, as an <a class="xref" href="IPA.Loader.IgnoreReason.html">IgnoreReason</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IReadOnlyDictionary&lt;PluginMetadata, IgnoreReason&gt; IgnoredPlugins { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.ireadonlydictionary-2">IReadOnlyDictionary</a>&lt;<a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a>, <a class="xref" href="IPA.Loader.IgnoreReason.html">IgnoreReason</a>&gt;</td>
<td><p>a dictionary of <a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a> to <a class="xref" href="IPA.Loader.IgnoreReason.html">IgnoreReason</a> of ignored plugins</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginManager_Plugins.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginManager.Plugins%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/a02c1e05d53c69a17f076b09be59aa0b4e554635/IPA.Loader/Loader/PluginManager.cs/#L318">View Source</a>
</span>
<a id="IPA_Loader_PluginManager_Plugins_" data-uid="IPA.Loader.PluginManager.Plugins*"></a>
<h4 id="IPA_Loader_PluginManager_Plugins" data-uid="IPA.Loader.PluginManager.Plugins">Plugins</h4>
<div class="markdown level1 summary"><p>An <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable&lt;T&gt;</a> of old IPA plugins.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Obsolete(&quot;This exists only to provide support for legacy IPA plugins based on the IPlugin interface.&quot;)]
public static IEnumerable&lt;IPlugin&gt; Plugins { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="IPA.Old.IPlugin.html">IPlugin</a>&gt;</td>
<td><p>all legacy plugin instances</p>
</td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginManager_GetDisabledPlugin_System_String_.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginManager.GetDisabledPlugin(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/a02c1e05d53c69a17f076b09be59aa0b4e554635/IPA.Loader/Loader/PluginManager.cs/#L63">View Source</a>
</span>
<a id="IPA_Loader_PluginManager_GetDisabledPlugin_" data-uid="IPA.Loader.PluginManager.GetDisabledPlugin*"></a>
<h4 id="IPA_Loader_PluginManager_GetDisabledPlugin_System_String_" data-uid="IPA.Loader.PluginManager.GetDisabledPlugin(System.String)">GetDisabledPlugin(String)</h4>
<div class="markdown level1 summary"><p>Gets a disabled plugin&apos;s metadata by its name.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static PluginMetadata GetDisabledPlugin(string name)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
<td><span class="parametername">name</span></td>
<td><p>the name of the disabled plugin to get</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td>
<td><p>the metadata for the corresponding plugin</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginManager_GetDisabledPluginFromId_System_String_.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginManager.GetDisabledPluginFromId(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/a02c1e05d53c69a17f076b09be59aa0b4e554635/IPA.Loader/Loader/PluginManager.cs/#L71">View Source</a>
</span>
<a id="IPA_Loader_PluginManager_GetDisabledPluginFromId_" data-uid="IPA.Loader.PluginManager.GetDisabledPluginFromId*"></a>
<h4 id="IPA_Loader_PluginManager_GetDisabledPluginFromId_System_String_" data-uid="IPA.Loader.PluginManager.GetDisabledPluginFromId(System.String)">GetDisabledPluginFromId(String)</h4>
<div class="markdown level1 summary"><p>Gets a disabled plugin&apos;s metadata by its ID.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static PluginMetadata GetDisabledPluginFromId(string name)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
<td><span class="parametername">name</span></td>
<td><p>the ID of the disabled plugin to get</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td>
<td><p>the metadata for the corresponding plugin</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginManager_GetPlugin_System_String_.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginManager.GetPlugin(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/a02c1e05d53c69a17f076b09be59aa0b4e554635/IPA.Loader/Loader/PluginManager.cs/#L47">View Source</a>
</span>
<a id="IPA_Loader_PluginManager_GetPlugin_" data-uid="IPA.Loader.PluginManager.GetPlugin*"></a>
<h4 id="IPA_Loader_PluginManager_GetPlugin_System_String_" data-uid="IPA.Loader.PluginManager.GetPlugin(System.String)">GetPlugin(String)</h4>
<div class="markdown level1 summary"><p>Gets info about the enabled plugin with the specified name.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static PluginMetadata GetPlugin(string name)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
<td><span class="parametername">name</span></td>
<td><p>the name of the plugin to get (must be an exact match)</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td>
<td><p>the plugin metadata for the requested plugin or <span class="xref">null</span> if it doesn&apos;t exist or is disabled</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginManager_GetPluginFromId_System_String_.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginManager.GetPluginFromId(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/a02c1e05d53c69a17f076b09be59aa0b4e554635/IPA.Loader/Loader/PluginManager.cs/#L55">View Source</a>
</span>
<a id="IPA_Loader_PluginManager_GetPluginFromId_" data-uid="IPA.Loader.PluginManager.GetPluginFromId*"></a>
<h4 id="IPA_Loader_PluginManager_GetPluginFromId_System_String_" data-uid="IPA.Loader.PluginManager.GetPluginFromId(System.String)">GetPluginFromId(String)</h4>
<div class="markdown level1 summary"><p>Gets info about the enabled plugin with the specified ID.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static PluginMetadata GetPluginFromId(string name)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
<td><span class="parametername">name</span></td>
<td><p>the ID name of the plugin to get (must be an exact match)</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td>
<td><p>the plugin metadata for the requested plugin or <span class="xref">null</span> if it doesn&apos;t exist or is disabled</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginManager_IsDisabled_IPA_Loader_PluginMetadata_.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginManager.IsDisabled(IPA.Loader.PluginMetadata)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/a02c1e05d53c69a17f076b09be59aa0b4e554635/IPA.Loader/Loader/PluginManager.cs/#L235">View Source</a>
</span>
<a id="IPA_Loader_PluginManager_IsDisabled_" data-uid="IPA.Loader.PluginManager.IsDisabled*"></a>
<h4 id="IPA_Loader_PluginManager_IsDisabled_IPA_Loader_PluginMetadata_" data-uid="IPA.Loader.PluginManager.IsDisabled(IPA.Loader.PluginMetadata)">IsDisabled(PluginMetadata)</h4>
<div class="markdown level1 summary"><p>Checks if a given plugin is disabled.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool IsDisabled(PluginMetadata meta)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td>
<td><span class="parametername">meta</span></td>
<td><p>the plugin to check</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
<td><p><span class="xref">true</span> if the plugin is disabled, <span class="xref">false</span> otherwise.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginManager_IsEnabled_IPA_Loader_PluginMetadata_.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginManager.IsEnabled(IPA.Loader.PluginMetadata)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/a02c1e05d53c69a17f076b09be59aa0b4e554635/IPA.Loader/Loader/PluginManager.cs/#L242">View Source</a>
</span>
<a id="IPA_Loader_PluginManager_IsEnabled_" data-uid="IPA.Loader.PluginManager.IsEnabled*"></a>
<h4 id="IPA_Loader_PluginManager_IsEnabled_IPA_Loader_PluginMetadata_" data-uid="IPA.Loader.PluginManager.IsEnabled(IPA.Loader.PluginMetadata)">IsEnabled(PluginMetadata)</h4>
<div class="markdown level1 summary"><p>Checks if a given plugin is enabled.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool IsEnabled(PluginMetadata meta)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td>
<td><span class="parametername">meta</span></td>
<td><p>the plugin to check</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
<td><p><span class="xref">true</span> if the plugin is enabled, <span class="xref">false</span> otherwise.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginManager_PluginStateTransaction.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginManager.PluginStateTransaction%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/a02c1e05d53c69a17f076b09be59aa0b4e554635/IPA.Loader/Loader/PluginManager.cs/#L78">View Source</a>
</span>
<a id="IPA_Loader_PluginManager_PluginStateTransaction_" data-uid="IPA.Loader.PluginManager.PluginStateTransaction*"></a>
<h4 id="IPA_Loader_PluginManager_PluginStateTransaction" data-uid="IPA.Loader.PluginManager.PluginStateTransaction">PluginStateTransaction()</h4>
<div class="markdown level1 summary"><p>Creates a new transaction for mod enabling and disabling mods simultaneously.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static StateTransitionTransaction PluginStateTransaction()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="IPA.Loader.StateTransitionTransaction.html">StateTransitionTransaction</a></td>
<td><p>a new <a class="xref" href="IPA.Loader.StateTransitionTransaction.html">StateTransitionTransaction</a> that captures the current state of loaded mods</p>
</td>
</tr>
</tbody>
</table>
<h3 id="events">Events
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginManager_OnAnyPluginsStateChanged.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginManager.OnAnyPluginsStateChanged%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/a02c1e05d53c69a17f076b09be59aa0b4e554635/IPA.Loader/Loader/PluginManager.cs/#L288">View Source</a>
</span>
<h4 id="IPA_Loader_PluginManager_OnAnyPluginsStateChanged" data-uid="IPA.Loader.PluginManager.OnAnyPluginsStateChanged">OnAnyPluginsStateChanged</h4>
<div class="markdown level1 summary"><p>Called whenever any plugins, regardless of whether or not their change occurs during runtime, have their state changed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static event PluginManager.OnAnyPluginsStateChangedDelegate OnAnyPluginsStateChanged</code></pre>
</div>
<h5 class="eventType">Event Type</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="IPA.Loader.PluginManager.OnAnyPluginsStateChangedDelegate.html">PluginManager.OnAnyPluginsStateChangedDelegate</a></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="IPA_Loader_PluginManager_OnAnyPluginsStateChanged_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>Note that this is called on the Unity main thread, and cannot therefore block, as the <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a>
provided represents operations that also run on the Unity main thread.</p>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginManager_OnPluginsStateChanged.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginManager.OnPluginsStateChanged%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/a02c1e05d53c69a17f076b09be59aa0b4e554635/IPA.Loader/Loader/PluginManager.cs/#L280">View Source</a>
</span>
<h4 id="IPA_Loader_PluginManager_OnPluginsStateChanged" data-uid="IPA.Loader.PluginManager.OnPluginsStateChanged">OnPluginsStateChanged</h4>
<div class="markdown level1 summary"><p>Called whenever any plugins have their state changed at runtime with the <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a> representing that state change.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static event Action&lt;Task&gt; OnPluginsStateChanged</code></pre>
</div>
<h5 class="eventType">Event Type</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.action-1">Action</a>&lt;<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="IPA_Loader_PluginManager_OnPluginsStateChanged_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>Note that this is called on the Unity main thread, and cannot therefore block, as the <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a>
provided represents operations that also run on the Unity main thread.</p>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginManager_PluginDisabled.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginManager.PluginDisabled%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/a02c1e05d53c69a17f076b09be59aa0b4e554635/IPA.Loader/Loader/PluginManager.cs/#L272">View Source</a>
</span>
<h4 id="IPA_Loader_PluginManager_PluginDisabled" data-uid="IPA.Loader.PluginManager.PluginDisabled">PluginDisabled</h4>
<div class="markdown level1 summary"><p>Called whenever a plugin is disabled, before the plugin in question is enabled.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static event PluginManager.PluginDisableDelegate PluginDisabled</code></pre>
</div>
<h5 class="eventType">Event Type</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="IPA.Loader.PluginManager.PluginDisableDelegate.html">PluginManager.PluginDisableDelegate</a></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginManager_PluginEnabled.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginManager.PluginEnabled%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/a02c1e05d53c69a17f076b09be59aa0b4e554635/IPA.Loader/Loader/PluginManager.cs/#L268">View Source</a>
</span>
<h4 id="IPA_Loader_PluginManager_PluginEnabled" data-uid="IPA.Loader.PluginManager.PluginEnabled">PluginEnabled</h4>
<div class="markdown level1 summary"><p>Called whenever a plugin is enabled, before the plugin in question is enabled.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static event PluginManager.PluginEnableDelegate PluginEnabled</code></pre>
</div>
<h5 class="eventType">Event Type</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="IPA.Loader.PluginManager.PluginEnableDelegate.html">PluginManager.PluginEnableDelegate</a></td>
<td></td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginManager.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginManager%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/a02c1e05d53c69a17f076b09be59aa0b4e554635/IPA.Loader/Loader/PluginManager.cs/#L35" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>