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.

661 lines
32 KiB

  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Class PluginManager
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class PluginManager
  11. ">
  12. <meta name="generator" content="docfx 2.48.0.0">
  13. <link rel="shortcut icon" href="../favicon.ico">
  14. <link rel="stylesheet" href="../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../styles/docfx.css">
  16. <link rel="stylesheet" href="../styles/main.css">
  17. <link rel="stylesheet" href="../styles/fix.css">
  18. <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
  19. <meta property="docfx:navrel" content="../toc.html">
  20. <meta property="docfx:tocrel" content="toc.html">
  21. <meta property="docfx:rel" content="../">
  22. <meta property="docfx:newtab" content="true">
  23. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  24. <div id="wrapper">
  25. <header>
  26. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  27. <div class="container">
  28. <div class="navbar-header">
  29. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  30. <span class="sr-only">Toggle navigation</span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. <span class="icon-bar"></span>
  34. </button>
  35. <a class="navbar-brand" href="../index.html">
  36. <img id="logo" class="svg" src="../logo.svg" alt="">
  37. </a>
  38. </div>
  39. <div class="collapse navbar-collapse" id="navbar">
  40. <form class="navbar-form navbar-right" role="search" id="search">
  41. <div class="form-group">
  42. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  43. </div>
  44. </form>
  45. </div>
  46. </div>
  47. </nav>
  48. <div class="subnav navbar navbar-default">
  49. <div class="container hide-when-search" id="breadcrumb">
  50. <ul class="breadcrumb">
  51. <li></li>
  52. </ul>
  53. </div>
  54. </div>
  55. </header>
  56. <div class="container body-content">
  57. <div id="search-results">
  58. <div class="search-list"></div>
  59. <div class="sr-items">
  60. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  61. </div>
  62. <ul id="pagination"></ul>
  63. </div>
  64. </div>
  65. <div role="main" class="container body-content hide-when-search">
  66. <div class="sidenav hide-when-search">
  67. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  68. <div class="sidetoggle collapse" id="sidetoggle">
  69. <div id="sidetoc"></div>
  70. </div>
  71. </div>
  72. <div class="article row grid-right">
  73. <div class="col-md-10">
  74. <article class="content wrap" id="_content" data-uid="IPA.Loader.PluginManager">
  75. <h1 id="IPA_Loader_PluginManager" data-uid="IPA.Loader.PluginManager" class="text-break">Class PluginManager
  76. </h1>
  77. <div class="markdown level0 summary"><p>The manager class for all plugins.</p>
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <div class="inheritance">
  81. <h5>Inheritance</h5>
  82. <div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
  83. <div class="level1"><span class="xref">PluginManager</span></div>
  84. </div>
  85. <div class="inheritedMembers">
  86. <h5>Inherited Members</h5>
  87. <div>
  88. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#System_Object_ToString">Object.ToString()</a>
  89. </div>
  90. <div>
  91. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_">Object.Equals(Object)</a>
  92. </div>
  93. <div>
  94. <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>
  95. </div>
  96. <div>
  97. <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>
  98. </div>
  99. <div>
  100. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#System_Object_GetHashCode">Object.GetHashCode()</a>
  101. </div>
  102. <div>
  103. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#System_Object_GetType">Object.GetType()</a>
  104. </div>
  105. <div>
  106. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#System_Object_MemberwiseClone">Object.MemberwiseClone()</a>
  107. </div>
  108. </div>
  109. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Loader.html">IPA.Loader</a></h6>
  110. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  111. <h5 id="IPA_Loader_PluginManager_syntax">Syntax</h5>
  112. <div class="codewrapper">
  113. <pre><code class="lang-csharp hljs">public static class PluginManager</code></pre>
  114. </div>
  115. <h3 id="properties">Properties
  116. </h3>
  117. <span class="small pull-right mobile-hide">
  118. <span class="divider">|</span>
  119. <a href="https://github.com/beat-saber-modding-group/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>
  120. </span>
  121. <span class="small pull-right mobile-hide">
  122. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/0d4317e21e35b308dcb31fb7c622d6c89d2d069c/IPA.Loader/Loader/PluginManager.cs/#L261">View Source</a>
  123. </span>
  124. <a id="IPA_Loader_PluginManager_AllPlugins_" data-uid="IPA.Loader.PluginManager.AllPlugins*"></a>
  125. <h4 id="IPA_Loader_PluginManager_AllPlugins" data-uid="IPA.Loader.PluginManager.AllPlugins">AllPlugins</h4>
  126. <div class="markdown level1 summary"><p>Gets a list of all enabled BSIPA plugins.</p>
  127. </div>
  128. <div class="markdown level1 conceptual"></div>
  129. <h5 class="decalaration">Declaration</h5>
  130. <div class="codewrapper">
  131. <pre><code class="lang-csharp hljs">public static IEnumerable&lt;PluginMetadata&gt; AllPlugins { get; }</code></pre>
  132. </div>
  133. <h5 class="propertyValue">Property Value</h5>
  134. <table class="table table-bordered table-striped table-condensed">
  135. <thead>
  136. <tr>
  137. <th>Type</th>
  138. <th>Description</th>
  139. </tr>
  140. </thead>
  141. <tbody>
  142. <tr>
  143. <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>
  144. <td><p>a collection of all enabled plugins as <a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a>s</p>
  145. </td>
  146. </tr>
  147. </tbody>
  148. </table>
  149. <span class="small pull-right mobile-hide">
  150. <span class="divider">|</span>
  151. <a href="https://github.com/beat-saber-modding-group/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>
  152. </span>
  153. <span class="small pull-right mobile-hide">
  154. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/0d4317e21e35b308dcb31fb7c622d6c89d2d069c/IPA.Loader/Loader/PluginManager.cs/#L232">View Source</a>
  155. </span>
  156. <a id="IPA_Loader_PluginManager_DisabledPlugins_" data-uid="IPA.Loader.PluginManager.DisabledPlugins*"></a>
  157. <h4 id="IPA_Loader_PluginManager_DisabledPlugins" data-uid="IPA.Loader.PluginManager.DisabledPlugins">DisabledPlugins</h4>
  158. <div class="markdown level1 summary"><p>Gets a list of disabled BSIPA plugins.</p>
  159. </div>
  160. <div class="markdown level1 conceptual"></div>
  161. <h5 class="decalaration">Declaration</h5>
  162. <div class="codewrapper">
  163. <pre><code class="lang-csharp hljs">public static IEnumerable&lt;PluginMetadata&gt; DisabledPlugins { get; }</code></pre>
  164. </div>
  165. <h5 class="propertyValue">Property Value</h5>
  166. <table class="table table-bordered table-striped table-condensed">
  167. <thead>
  168. <tr>
  169. <th>Type</th>
  170. <th>Description</th>
  171. </tr>
  172. </thead>
  173. <tbody>
  174. <tr>
  175. <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>
  176. <td><p>a collection of all disabled plugins as <a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></p>
  177. </td>
  178. </tr>
  179. </tbody>
  180. </table>
  181. <span class="small pull-right mobile-hide">
  182. <span class="divider">|</span>
  183. <a href="https://github.com/beat-saber-modding-group/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>
  184. </span>
  185. <span class="small pull-right mobile-hide">
  186. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/0d4317e21e35b308dcb31fb7c622d6c89d2d069c/IPA.Loader/Loader/PluginManager.cs/#L267">View Source</a>
  187. </span>
  188. <a id="IPA_Loader_PluginManager_Plugins_" data-uid="IPA.Loader.PluginManager.Plugins*"></a>
  189. <h4 id="IPA_Loader_PluginManager_Plugins" data-uid="IPA.Loader.PluginManager.Plugins">Plugins</h4>
  190. <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>
  191. </div>
  192. <div class="markdown level1 conceptual"></div>
  193. <h5 class="decalaration">Declaration</h5>
  194. <div class="codewrapper">
  195. <pre><code class="lang-csharp hljs">[Obsolete(&quot;I mean, IPlugin shouldn't be used, so why should this? Not renaming to extend support for old plugins.&quot;)]
  196. public static IEnumerable&lt;IPlugin&gt; Plugins { get; }</code></pre>
  197. </div>
  198. <h5 class="propertyValue">Property Value</h5>
  199. <table class="table table-bordered table-striped table-condensed">
  200. <thead>
  201. <tr>
  202. <th>Type</th>
  203. <th>Description</th>
  204. </tr>
  205. </thead>
  206. <tbody>
  207. <tr>
  208. <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>
  209. <td><p>all legacy plugin instances</p>
  210. </td>
  211. </tr>
  212. </tbody>
  213. </table>
  214. <h3 id="methods">Methods
  215. </h3>
  216. <span class="small pull-right mobile-hide">
  217. <span class="divider">|</span>
  218. <a href="https://github.com/beat-saber-modding-group/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>
  219. </span>
  220. <span class="small pull-right mobile-hide">
  221. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/0d4317e21e35b308dcb31fb7c622d6c89d2d069c/IPA.Loader/Loader/PluginManager.cs/#L62">View Source</a>
  222. </span>
  223. <a id="IPA_Loader_PluginManager_GetDisabledPlugin_" data-uid="IPA.Loader.PluginManager.GetDisabledPlugin*"></a>
  224. <h4 id="IPA_Loader_PluginManager_GetDisabledPlugin_System_String_" data-uid="IPA.Loader.PluginManager.GetDisabledPlugin(System.String)">GetDisabledPlugin(String)</h4>
  225. <div class="markdown level1 summary"><p>Gets a disabled plugin&apos;s metadata by its name.</p>
  226. </div>
  227. <div class="markdown level1 conceptual"></div>
  228. <h5 class="decalaration">Declaration</h5>
  229. <div class="codewrapper">
  230. <pre><code class="lang-csharp hljs">public static PluginMetadata GetDisabledPlugin(string name)</code></pre>
  231. </div>
  232. <h5 class="parameters">Parameters</h5>
  233. <table class="table table-bordered table-striped table-condensed">
  234. <thead>
  235. <tr>
  236. <th>Type</th>
  237. <th>Name</th>
  238. <th>Description</th>
  239. </tr>
  240. </thead>
  241. <tbody>
  242. <tr>
  243. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  244. <td><span class="parametername">name</span></td>
  245. <td><p>the name of the disabled plugin to get</p>
  246. </td>
  247. </tr>
  248. </tbody>
  249. </table>
  250. <h5 class="returns">Returns</h5>
  251. <table class="table table-bordered table-striped table-condensed">
  252. <thead>
  253. <tr>
  254. <th>Type</th>
  255. <th>Description</th>
  256. </tr>
  257. </thead>
  258. <tbody>
  259. <tr>
  260. <td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td>
  261. <td><p>the metadata for the corresponding plugin</p>
  262. </td>
  263. </tr>
  264. </tbody>
  265. </table>
  266. <span class="small pull-right mobile-hide">
  267. <span class="divider">|</span>
  268. <a href="https://github.com/beat-saber-modding-group/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>
  269. </span>
  270. <span class="small pull-right mobile-hide">
  271. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/0d4317e21e35b308dcb31fb7c622d6c89d2d069c/IPA.Loader/Loader/PluginManager.cs/#L70">View Source</a>
  272. </span>
  273. <a id="IPA_Loader_PluginManager_GetDisabledPluginFromId_" data-uid="IPA.Loader.PluginManager.GetDisabledPluginFromId*"></a>
  274. <h4 id="IPA_Loader_PluginManager_GetDisabledPluginFromId_System_String_" data-uid="IPA.Loader.PluginManager.GetDisabledPluginFromId(System.String)">GetDisabledPluginFromId(String)</h4>
  275. <div class="markdown level1 summary"><p>Gets a disabled plugin&apos;s metadata by its ID.</p>
  276. </div>
  277. <div class="markdown level1 conceptual"></div>
  278. <h5 class="decalaration">Declaration</h5>
  279. <div class="codewrapper">
  280. <pre><code class="lang-csharp hljs">public static PluginMetadata GetDisabledPluginFromId(string name)</code></pre>
  281. </div>
  282. <h5 class="parameters">Parameters</h5>
  283. <table class="table table-bordered table-striped table-condensed">
  284. <thead>
  285. <tr>
  286. <th>Type</th>
  287. <th>Name</th>
  288. <th>Description</th>
  289. </tr>
  290. </thead>
  291. <tbody>
  292. <tr>
  293. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  294. <td><span class="parametername">name</span></td>
  295. <td><p>the ID of the disabled plugin to get</p>
  296. </td>
  297. </tr>
  298. </tbody>
  299. </table>
  300. <h5 class="returns">Returns</h5>
  301. <table class="table table-bordered table-striped table-condensed">
  302. <thead>
  303. <tr>
  304. <th>Type</th>
  305. <th>Description</th>
  306. </tr>
  307. </thead>
  308. <tbody>
  309. <tr>
  310. <td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td>
  311. <td><p>the metadata for the corresponding plugin</p>
  312. </td>
  313. </tr>
  314. </tbody>
  315. </table>
  316. <span class="small pull-right mobile-hide">
  317. <span class="divider">|</span>
  318. <a href="https://github.com/beat-saber-modding-group/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>
  319. </span>
  320. <span class="small pull-right mobile-hide">
  321. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/0d4317e21e35b308dcb31fb7c622d6c89d2d069c/IPA.Loader/Loader/PluginManager.cs/#L46">View Source</a>
  322. </span>
  323. <a id="IPA_Loader_PluginManager_GetPlugin_" data-uid="IPA.Loader.PluginManager.GetPlugin*"></a>
  324. <h4 id="IPA_Loader_PluginManager_GetPlugin_System_String_" data-uid="IPA.Loader.PluginManager.GetPlugin(System.String)">GetPlugin(String)</h4>
  325. <div class="markdown level1 summary"><p>Gets info about the enabled plugin with the specified name.</p>
  326. </div>
  327. <div class="markdown level1 conceptual"></div>
  328. <h5 class="decalaration">Declaration</h5>
  329. <div class="codewrapper">
  330. <pre><code class="lang-csharp hljs">public static PluginMetadata GetPlugin(string name)</code></pre>
  331. </div>
  332. <h5 class="parameters">Parameters</h5>
  333. <table class="table table-bordered table-striped table-condensed">
  334. <thead>
  335. <tr>
  336. <th>Type</th>
  337. <th>Name</th>
  338. <th>Description</th>
  339. </tr>
  340. </thead>
  341. <tbody>
  342. <tr>
  343. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  344. <td><span class="parametername">name</span></td>
  345. <td><p>the name of the plugin to get (must be an exact match)</p>
  346. </td>
  347. </tr>
  348. </tbody>
  349. </table>
  350. <h5 class="returns">Returns</h5>
  351. <table class="table table-bordered table-striped table-condensed">
  352. <thead>
  353. <tr>
  354. <th>Type</th>
  355. <th>Description</th>
  356. </tr>
  357. </thead>
  358. <tbody>
  359. <tr>
  360. <td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td>
  361. <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>
  362. </td>
  363. </tr>
  364. </tbody>
  365. </table>
  366. <span class="small pull-right mobile-hide">
  367. <span class="divider">|</span>
  368. <a href="https://github.com/beat-saber-modding-group/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>
  369. </span>
  370. <span class="small pull-right mobile-hide">
  371. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/0d4317e21e35b308dcb31fb7c622d6c89d2d069c/IPA.Loader/Loader/PluginManager.cs/#L54">View Source</a>
  372. </span>
  373. <a id="IPA_Loader_PluginManager_GetPluginFromId_" data-uid="IPA.Loader.PluginManager.GetPluginFromId*"></a>
  374. <h4 id="IPA_Loader_PluginManager_GetPluginFromId_System_String_" data-uid="IPA.Loader.PluginManager.GetPluginFromId(System.String)">GetPluginFromId(String)</h4>
  375. <div class="markdown level1 summary"><p>Gets info about the enabled plugin with the specified ID.</p>
  376. </div>
  377. <div class="markdown level1 conceptual"></div>
  378. <h5 class="decalaration">Declaration</h5>
  379. <div class="codewrapper">
  380. <pre><code class="lang-csharp hljs">public static PluginMetadata GetPluginFromId(string name)</code></pre>
  381. </div>
  382. <h5 class="parameters">Parameters</h5>
  383. <table class="table table-bordered table-striped table-condensed">
  384. <thead>
  385. <tr>
  386. <th>Type</th>
  387. <th>Name</th>
  388. <th>Description</th>
  389. </tr>
  390. </thead>
  391. <tbody>
  392. <tr>
  393. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  394. <td><span class="parametername">name</span></td>
  395. <td><p>the ID name of the plugin to get (must be an exact match)</p>
  396. </td>
  397. </tr>
  398. </tbody>
  399. </table>
  400. <h5 class="returns">Returns</h5>
  401. <table class="table table-bordered table-striped table-condensed">
  402. <thead>
  403. <tr>
  404. <th>Type</th>
  405. <th>Description</th>
  406. </tr>
  407. </thead>
  408. <tbody>
  409. <tr>
  410. <td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td>
  411. <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>
  412. </td>
  413. </tr>
  414. </tbody>
  415. </table>
  416. <span class="small pull-right mobile-hide">
  417. <span class="divider">|</span>
  418. <a href="https://github.com/beat-saber-modding-group/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>
  419. </span>
  420. <span class="small pull-right mobile-hide">
  421. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/0d4317e21e35b308dcb31fb7c622d6c89d2d069c/IPA.Loader/Loader/PluginManager.cs/#L219">View Source</a>
  422. </span>
  423. <a id="IPA_Loader_PluginManager_IsDisabled_" data-uid="IPA.Loader.PluginManager.IsDisabled*"></a>
  424. <h4 id="IPA_Loader_PluginManager_IsDisabled_IPA_Loader_PluginMetadata_" data-uid="IPA.Loader.PluginManager.IsDisabled(IPA.Loader.PluginMetadata)">IsDisabled(PluginMetadata)</h4>
  425. <div class="markdown level1 summary"><p>Checks if a given plugin is disabled.</p>
  426. </div>
  427. <div class="markdown level1 conceptual"></div>
  428. <h5 class="decalaration">Declaration</h5>
  429. <div class="codewrapper">
  430. <pre><code class="lang-csharp hljs">public static bool IsDisabled(PluginMetadata meta)</code></pre>
  431. </div>
  432. <h5 class="parameters">Parameters</h5>
  433. <table class="table table-bordered table-striped table-condensed">
  434. <thead>
  435. <tr>
  436. <th>Type</th>
  437. <th>Name</th>
  438. <th>Description</th>
  439. </tr>
  440. </thead>
  441. <tbody>
  442. <tr>
  443. <td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td>
  444. <td><span class="parametername">meta</span></td>
  445. <td><p>the plugin to check</p>
  446. </td>
  447. </tr>
  448. </tbody>
  449. </table>
  450. <h5 class="returns">Returns</h5>
  451. <table class="table table-bordered table-striped table-condensed">
  452. <thead>
  453. <tr>
  454. <th>Type</th>
  455. <th>Description</th>
  456. </tr>
  457. </thead>
  458. <tbody>
  459. <tr>
  460. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  461. <td><p><span class="xref">true</span> if the plugin is disabled, <span class="xref">false</span> otherwise.</p>
  462. </td>
  463. </tr>
  464. </tbody>
  465. </table>
  466. <span class="small pull-right mobile-hide">
  467. <span class="divider">|</span>
  468. <a href="https://github.com/beat-saber-modding-group/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>
  469. </span>
  470. <span class="small pull-right mobile-hide">
  471. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/0d4317e21e35b308dcb31fb7c622d6c89d2d069c/IPA.Loader/Loader/PluginManager.cs/#L226">View Source</a>
  472. </span>
  473. <a id="IPA_Loader_PluginManager_IsEnabled_" data-uid="IPA.Loader.PluginManager.IsEnabled*"></a>
  474. <h4 id="IPA_Loader_PluginManager_IsEnabled_IPA_Loader_PluginMetadata_" data-uid="IPA.Loader.PluginManager.IsEnabled(IPA.Loader.PluginMetadata)">IsEnabled(PluginMetadata)</h4>
  475. <div class="markdown level1 summary"><p>Checks if a given plugin is enabled.</p>
  476. </div>
  477. <div class="markdown level1 conceptual"></div>
  478. <h5 class="decalaration">Declaration</h5>
  479. <div class="codewrapper">
  480. <pre><code class="lang-csharp hljs">public static bool IsEnabled(PluginMetadata meta)</code></pre>
  481. </div>
  482. <h5 class="parameters">Parameters</h5>
  483. <table class="table table-bordered table-striped table-condensed">
  484. <thead>
  485. <tr>
  486. <th>Type</th>
  487. <th>Name</th>
  488. <th>Description</th>
  489. </tr>
  490. </thead>
  491. <tbody>
  492. <tr>
  493. <td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td>
  494. <td><span class="parametername">meta</span></td>
  495. <td><p>the plugin to check</p>
  496. </td>
  497. </tr>
  498. </tbody>
  499. </table>
  500. <h5 class="returns">Returns</h5>
  501. <table class="table table-bordered table-striped table-condensed">
  502. <thead>
  503. <tr>
  504. <th>Type</th>
  505. <th>Description</th>
  506. </tr>
  507. </thead>
  508. <tbody>
  509. <tr>
  510. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  511. <td><p><span class="xref">true</span> if the plugin is enabled, <span class="xref">false</span> otherwise.</p>
  512. </td>
  513. </tr>
  514. </tbody>
  515. </table>
  516. <span class="small pull-right mobile-hide">
  517. <span class="divider">|</span>
  518. <a href="https://github.com/beat-saber-modding-group/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>
  519. </span>
  520. <span class="small pull-right mobile-hide">
  521. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/0d4317e21e35b308dcb31fb7c622d6c89d2d069c/IPA.Loader/Loader/PluginManager.cs/#L77">View Source</a>
  522. </span>
  523. <a id="IPA_Loader_PluginManager_PluginStateTransaction_" data-uid="IPA.Loader.PluginManager.PluginStateTransaction*"></a>
  524. <h4 id="IPA_Loader_PluginManager_PluginStateTransaction" data-uid="IPA.Loader.PluginManager.PluginStateTransaction">PluginStateTransaction()</h4>
  525. <div class="markdown level1 summary"><p>Creates a new transaction for mod enabling and disabling mods simultaneously.</p>
  526. </div>
  527. <div class="markdown level1 conceptual"></div>
  528. <h5 class="decalaration">Declaration</h5>
  529. <div class="codewrapper">
  530. <pre><code class="lang-csharp hljs">public static StateTransitionTransaction PluginStateTransaction()</code></pre>
  531. </div>
  532. <h5 class="returns">Returns</h5>
  533. <table class="table table-bordered table-striped table-condensed">
  534. <thead>
  535. <tr>
  536. <th>Type</th>
  537. <th>Description</th>
  538. </tr>
  539. </thead>
  540. <tbody>
  541. <tr>
  542. <td><a class="xref" href="IPA.Loader.StateTransitionTransaction.html">StateTransitionTransaction</a></td>
  543. <td><p>a new <a class="xref" href="IPA.Loader.StateTransitionTransaction.html">StateTransitionTransaction</a> that captures the current state of loaded mods</p>
  544. </td>
  545. </tr>
  546. </tbody>
  547. </table>
  548. <h3 id="events">Events
  549. </h3>
  550. <span class="small pull-right mobile-hide">
  551. <span class="divider">|</span>
  552. <a href="https://github.com/beat-saber-modding-group/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>
  553. </span>
  554. <span class="small pull-right mobile-hide">
  555. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/0d4317e21e35b308dcb31fb7c622d6c89d2d069c/IPA.Loader/Loader/PluginManager.cs/#L255">View Source</a>
  556. </span>
  557. <h4 id="IPA_Loader_PluginManager_PluginDisabled" data-uid="IPA.Loader.PluginManager.PluginDisabled">PluginDisabled</h4>
  558. <div class="markdown level1 summary"><p>Called whenever a plugin is disabled.</p>
  559. </div>
  560. <div class="markdown level1 conceptual"></div>
  561. <h5 class="decalaration">Declaration</h5>
  562. <div class="codewrapper">
  563. <pre><code class="lang-csharp hljs">public static event PluginManager.PluginDisableDelegate PluginDisabled</code></pre>
  564. </div>
  565. <h5 class="eventType">Event Type</h5>
  566. <table class="table table-bordered table-striped table-condensed">
  567. <thead>
  568. <tr>
  569. <th>Type</th>
  570. <th>Description</th>
  571. </tr>
  572. </thead>
  573. <tbody>
  574. <tr>
  575. <td><a class="xref" href="IPA.Loader.PluginManager.PluginDisableDelegate.html">PluginManager.PluginDisableDelegate</a></td>
  576. <td></td>
  577. </tr>
  578. </tbody>
  579. </table>
  580. <span class="small pull-right mobile-hide">
  581. <span class="divider">|</span>
  582. <a href="https://github.com/beat-saber-modding-group/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>
  583. </span>
  584. <span class="small pull-right mobile-hide">
  585. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/0d4317e21e35b308dcb31fb7c622d6c89d2d069c/IPA.Loader/Loader/PluginManager.cs/#L251">View Source</a>
  586. </span>
  587. <h4 id="IPA_Loader_PluginManager_PluginEnabled" data-uid="IPA.Loader.PluginManager.PluginEnabled">PluginEnabled</h4>
  588. <div class="markdown level1 summary"><p>Called whenever a plugin is enabled.</p>
  589. </div>
  590. <div class="markdown level1 conceptual"></div>
  591. <h5 class="decalaration">Declaration</h5>
  592. <div class="codewrapper">
  593. <pre><code class="lang-csharp hljs">public static event PluginManager.PluginEnableDelegate PluginEnabled</code></pre>
  594. </div>
  595. <h5 class="eventType">Event Type</h5>
  596. <table class="table table-bordered table-striped table-condensed">
  597. <thead>
  598. <tr>
  599. <th>Type</th>
  600. <th>Description</th>
  601. </tr>
  602. </thead>
  603. <tbody>
  604. <tr>
  605. <td><a class="xref" href="IPA.Loader.PluginManager.PluginEnableDelegate.html">PluginManager.PluginEnableDelegate</a></td>
  606. <td></td>
  607. </tr>
  608. </tbody>
  609. </table>
  610. </article>
  611. </div>
  612. <div class="hidden-sm col-md-2" role="complementary">
  613. <div class="sideaffix">
  614. <div class="contribution">
  615. <ul class="nav">
  616. <li>
  617. <a href="https://github.com/beat-saber-modding-group/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>
  618. </li>
  619. <li>
  620. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/0d4317e21e35b308dcb31fb7c622d6c89d2d069c/IPA.Loader/Loader/PluginManager.cs/#L34" class="contribution-link">View Source</a>
  621. </li>
  622. </ul>
  623. </div>
  624. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  625. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  626. </nav>
  627. </div>
  628. </div>
  629. </div>
  630. </div>
  631. <footer>
  632. <div class="grad-bottom"></div>
  633. <div class="footer">
  634. <div class="container">
  635. <span class="pull-right">
  636. <a href="#top">Back to top</a>
  637. </span>
  638. <span>Generated by <strong>DocFX</strong></span>
  639. </div>
  640. </div>
  641. </footer>
  642. </div>
  643. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  644. <script type="text/javascript" src="../styles/docfx.js"></script>
  645. <script type="text/javascript" src="../styles/main.js"></script>
  646. </body>
  647. </html>