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.

769 lines
38 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.59.3.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">Search Results for <span></span></div>
  59. <div class="sr-items">
  60. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  61. </div>
  62. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></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. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Loader.html">IPA.Loader</a></h6>
  86. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  87. <h5 id="IPA_Loader_PluginManager_syntax">Syntax</h5>
  88. <div class="codewrapper">
  89. <pre><code class="lang-csharp hljs">public static class PluginManager : object</code></pre>
  90. </div>
  91. <h3 id="properties">Properties
  92. </h3>
  93. <span class="small pull-right mobile-hide">
  94. <span class="divider">|</span>
  95. <a href="https://github.com/nike4613/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>
  96. </span>
  97. <span class="small pull-right mobile-hide">
  98. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Loader/PluginManager.cs/#L313">View Source</a>
  99. </span>
  100. <a id="IPA_Loader_PluginManager_AllPlugins_" data-uid="IPA.Loader.PluginManager.AllPlugins*"></a>
  101. <h4 id="IPA_Loader_PluginManager_AllPlugins" data-uid="IPA.Loader.PluginManager.AllPlugins">AllPlugins</h4>
  102. <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>
  103. </div>
  104. <div class="markdown level1 conceptual"></div>
  105. <h5 class="decalaration">Declaration</h5>
  106. <div class="codewrapper">
  107. <pre><code class="lang-csharp hljs">public static IEnumerable&lt;PluginMetadata&gt; AllPlugins { get; }</code></pre>
  108. </div>
  109. <h5 class="propertyValue">Property Value</h5>
  110. <table class="table table-bordered table-striped table-condensed">
  111. <thead>
  112. <tr>
  113. <th>Type</th>
  114. <th>Description</th>
  115. </tr>
  116. </thead>
  117. <tbody>
  118. <tr>
  119. <td><span class="xref">IEnumerable</span>&lt;<a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a>&gt;</td>
  120. <td><p>a collection of all enabled plugins as <a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a>s</p>
  121. </td>
  122. </tr>
  123. </tbody>
  124. </table>
  125. <span class="small pull-right mobile-hide">
  126. <span class="divider">|</span>
  127. <a href="https://github.com/nike4613/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>
  128. </span>
  129. <span class="small pull-right mobile-hide">
  130. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Loader/PluginManager.cs/#L324">View Source</a>
  131. </span>
  132. <a id="IPA_Loader_PluginManager_DisabledPlugins_" data-uid="IPA.Loader.PluginManager.DisabledPlugins*"></a>
  133. <h4 id="IPA_Loader_PluginManager_DisabledPlugins" data-uid="IPA.Loader.PluginManager.DisabledPlugins">DisabledPlugins</h4>
  134. <div class="markdown level1 summary"><p>Gets a list of disabled BSIPA plugins.</p>
  135. </div>
  136. <div class="markdown level1 conceptual"></div>
  137. <h5 class="decalaration">Declaration</h5>
  138. <div class="codewrapper">
  139. <pre><code class="lang-csharp hljs">public static IEnumerable&lt;PluginMetadata&gt; DisabledPlugins { get; }</code></pre>
  140. </div>
  141. <h5 class="propertyValue">Property Value</h5>
  142. <table class="table table-bordered table-striped table-condensed">
  143. <thead>
  144. <tr>
  145. <th>Type</th>
  146. <th>Description</th>
  147. </tr>
  148. </thead>
  149. <tbody>
  150. <tr>
  151. <td><span class="xref">IEnumerable</span>&lt;<a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a>&gt;</td>
  152. <td><p>a collection of all disabled plugins as <a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></p>
  153. </td>
  154. </tr>
  155. </tbody>
  156. </table>
  157. <span class="small pull-right mobile-hide">
  158. <span class="divider">|</span>
  159. <a href="https://github.com/nike4613/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>
  160. </span>
  161. <span class="small pull-right mobile-hide">
  162. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Loader/PluginManager.cs/#L319">View Source</a>
  163. </span>
  164. <a id="IPA_Loader_PluginManager_EnabledPlugins_" data-uid="IPA.Loader.PluginManager.EnabledPlugins*"></a>
  165. <h4 id="IPA_Loader_PluginManager_EnabledPlugins" data-uid="IPA.Loader.PluginManager.EnabledPlugins">EnabledPlugins</h4>
  166. <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>
  167. </div>
  168. <div class="markdown level1 conceptual"></div>
  169. <h5 class="decalaration">Declaration</h5>
  170. <div class="codewrapper">
  171. <pre><code class="lang-csharp hljs">public static IEnumerable&lt;PluginMetadata&gt; EnabledPlugins { get; }</code></pre>
  172. </div>
  173. <h5 class="propertyValue">Property Value</h5>
  174. <table class="table table-bordered table-striped table-condensed">
  175. <thead>
  176. <tr>
  177. <th>Type</th>
  178. <th>Description</th>
  179. </tr>
  180. </thead>
  181. <tbody>
  182. <tr>
  183. <td><span class="xref">IEnumerable</span>&lt;<a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a>&gt;</td>
  184. <td><p>a collection of all enabled plugins</p>
  185. </td>
  186. </tr>
  187. </tbody>
  188. </table>
  189. <span class="small pull-right mobile-hide">
  190. <span class="divider">|</span>
  191. <a href="https://github.com/nike4613/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>
  192. </span>
  193. <span class="small pull-right mobile-hide">
  194. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Loader/PluginManager.cs/#L331">View Source</a>
  195. </span>
  196. <a id="IPA_Loader_PluginManager_IgnoredPlugins_" data-uid="IPA.Loader.PluginManager.IgnoredPlugins*"></a>
  197. <h4 id="IPA_Loader_PluginManager_IgnoredPlugins" data-uid="IPA.Loader.PluginManager.IgnoredPlugins">IgnoredPlugins</h4>
  198. <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>
  199. </div>
  200. <div class="markdown level1 conceptual"></div>
  201. <h5 class="decalaration">Declaration</h5>
  202. <div class="codewrapper">
  203. <pre><code class="lang-csharp hljs">public static IReadOnlyDictionary&lt;PluginMetadata, IgnoreReason&gt; IgnoredPlugins { get; }</code></pre>
  204. </div>
  205. <h5 class="propertyValue">Property Value</h5>
  206. <table class="table table-bordered table-striped table-condensed">
  207. <thead>
  208. <tr>
  209. <th>Type</th>
  210. <th>Description</th>
  211. </tr>
  212. </thead>
  213. <tbody>
  214. <tr>
  215. <td><span class="xref">IReadOnlyDictionary</span>&lt;<a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a>, <a class="xref" href="IPA.Loader.IgnoreReason.html">IgnoreReason</a>&gt;</td>
  216. <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>
  217. </td>
  218. </tr>
  219. </tbody>
  220. </table>
  221. <span class="small pull-right mobile-hide">
  222. <span class="divider">|</span>
  223. <a href="https://github.com/nike4613/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>
  224. </span>
  225. <span class="small pull-right mobile-hide">
  226. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Loader/PluginManager.cs/#L337">View Source</a>
  227. </span>
  228. <a id="IPA_Loader_PluginManager_Plugins_" data-uid="IPA.Loader.PluginManager.Plugins*"></a>
  229. <h4 id="IPA_Loader_PluginManager_Plugins" data-uid="IPA.Loader.PluginManager.Plugins">Plugins</h4>
  230. <div class="markdown level1 summary"><p>An <see cref="!:IEnumerable&lt;T>"></see> of old IPA plugins.</p>
  231. </div>
  232. <div class="markdown level1 conceptual"></div>
  233. <h5 class="decalaration">Declaration</h5>
  234. <div class="codewrapper">
  235. <pre><code class="lang-csharp hljs">public static IEnumerable&lt;IPlugin&gt; Plugins { get; }</code></pre>
  236. </div>
  237. <h5 class="propertyValue">Property Value</h5>
  238. <table class="table table-bordered table-striped table-condensed">
  239. <thead>
  240. <tr>
  241. <th>Type</th>
  242. <th>Description</th>
  243. </tr>
  244. </thead>
  245. <tbody>
  246. <tr>
  247. <td><span class="xref">IEnumerable</span>&lt;<a class="xref" href="IPA.Old.IPlugin.html">IPlugin</a>&gt;</td>
  248. <td><p>all legacy plugin instances</p>
  249. </td>
  250. </tr>
  251. </tbody>
  252. </table>
  253. <h3 id="methods">Methods
  254. </h3>
  255. <span class="small pull-right mobile-hide">
  256. <span class="divider">|</span>
  257. <a href="https://github.com/nike4613/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>
  258. </span>
  259. <span class="small pull-right mobile-hide">
  260. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Loader/PluginManager.cs/#L63">View Source</a>
  261. </span>
  262. <a id="IPA_Loader_PluginManager_GetDisabledPlugin_" data-uid="IPA.Loader.PluginManager.GetDisabledPlugin*"></a>
  263. <h4 id="IPA_Loader_PluginManager_GetDisabledPlugin_System_String_" data-uid="IPA.Loader.PluginManager.GetDisabledPlugin(System.String)">GetDisabledPlugin(String)</h4>
  264. <div class="markdown level1 summary"><p>Gets a disabled plugin&apos;s metadata by its name.</p>
  265. </div>
  266. <div class="markdown level1 conceptual"></div>
  267. <h5 class="decalaration">Declaration</h5>
  268. <div class="codewrapper">
  269. <pre><code class="lang-csharp hljs">public static PluginMetadata GetDisabledPlugin(string name)</code></pre>
  270. </div>
  271. <h5 class="parameters">Parameters</h5>
  272. <table class="table table-bordered table-striped table-condensed">
  273. <thead>
  274. <tr>
  275. <th>Type</th>
  276. <th>Name</th>
  277. <th>Description</th>
  278. </tr>
  279. </thead>
  280. <tbody>
  281. <tr>
  282. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  283. <td><span class="parametername">name</span></td>
  284. <td><p>the name of the disabled plugin to get</p>
  285. </td>
  286. </tr>
  287. </tbody>
  288. </table>
  289. <h5 class="returns">Returns</h5>
  290. <table class="table table-bordered table-striped table-condensed">
  291. <thead>
  292. <tr>
  293. <th>Type</th>
  294. <th>Description</th>
  295. </tr>
  296. </thead>
  297. <tbody>
  298. <tr>
  299. <td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td>
  300. <td><p>the metadata for the corresponding plugin</p>
  301. </td>
  302. </tr>
  303. </tbody>
  304. </table>
  305. <span class="small pull-right mobile-hide">
  306. <span class="divider">|</span>
  307. <a href="https://github.com/nike4613/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>
  308. </span>
  309. <span class="small pull-right mobile-hide">
  310. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Loader/PluginManager.cs/#L71">View Source</a>
  311. </span>
  312. <a id="IPA_Loader_PluginManager_GetDisabledPluginFromId_" data-uid="IPA.Loader.PluginManager.GetDisabledPluginFromId*"></a>
  313. <h4 id="IPA_Loader_PluginManager_GetDisabledPluginFromId_System_String_" data-uid="IPA.Loader.PluginManager.GetDisabledPluginFromId(System.String)">GetDisabledPluginFromId(String)</h4>
  314. <div class="markdown level1 summary"><p>Gets a disabled plugin&apos;s metadata by its ID.</p>
  315. </div>
  316. <div class="markdown level1 conceptual"></div>
  317. <h5 class="decalaration">Declaration</h5>
  318. <div class="codewrapper">
  319. <pre><code class="lang-csharp hljs">public static PluginMetadata GetDisabledPluginFromId(string id)</code></pre>
  320. </div>
  321. <h5 class="parameters">Parameters</h5>
  322. <table class="table table-bordered table-striped table-condensed">
  323. <thead>
  324. <tr>
  325. <th>Type</th>
  326. <th>Name</th>
  327. <th>Description</th>
  328. </tr>
  329. </thead>
  330. <tbody>
  331. <tr>
  332. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  333. <td><span class="parametername">id</span></td>
  334. <td><p>the ID of the disabled plugin to get</p>
  335. </td>
  336. </tr>
  337. </tbody>
  338. </table>
  339. <h5 class="returns">Returns</h5>
  340. <table class="table table-bordered table-striped table-condensed">
  341. <thead>
  342. <tr>
  343. <th>Type</th>
  344. <th>Description</th>
  345. </tr>
  346. </thead>
  347. <tbody>
  348. <tr>
  349. <td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td>
  350. <td><p>the metadata for the corresponding plugin</p>
  351. </td>
  352. </tr>
  353. </tbody>
  354. </table>
  355. <span class="small pull-right mobile-hide">
  356. <span class="divider">|</span>
  357. <a href="https://github.com/nike4613/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>
  358. </span>
  359. <span class="small pull-right mobile-hide">
  360. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Loader/PluginManager.cs/#L47">View Source</a>
  361. </span>
  362. <a id="IPA_Loader_PluginManager_GetPlugin_" data-uid="IPA.Loader.PluginManager.GetPlugin*"></a>
  363. <h4 id="IPA_Loader_PluginManager_GetPlugin_System_String_" data-uid="IPA.Loader.PluginManager.GetPlugin(System.String)">GetPlugin(String)</h4>
  364. <div class="markdown level1 summary"><p>Gets info about the enabled plugin with the specified name.</p>
  365. </div>
  366. <div class="markdown level1 conceptual"></div>
  367. <h5 class="decalaration">Declaration</h5>
  368. <div class="codewrapper">
  369. <pre><code class="lang-csharp hljs">public static PluginMetadata GetPlugin(string name)</code></pre>
  370. </div>
  371. <h5 class="parameters">Parameters</h5>
  372. <table class="table table-bordered table-striped table-condensed">
  373. <thead>
  374. <tr>
  375. <th>Type</th>
  376. <th>Name</th>
  377. <th>Description</th>
  378. </tr>
  379. </thead>
  380. <tbody>
  381. <tr>
  382. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  383. <td><span class="parametername">name</span></td>
  384. <td><p>the name of the plugin to get (must be an exact match)</p>
  385. </td>
  386. </tr>
  387. </tbody>
  388. </table>
  389. <h5 class="returns">Returns</h5>
  390. <table class="table table-bordered table-striped table-condensed">
  391. <thead>
  392. <tr>
  393. <th>Type</th>
  394. <th>Description</th>
  395. </tr>
  396. </thead>
  397. <tbody>
  398. <tr>
  399. <td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td>
  400. <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>
  401. </td>
  402. </tr>
  403. </tbody>
  404. </table>
  405. <span class="small pull-right mobile-hide">
  406. <span class="divider">|</span>
  407. <a href="https://github.com/nike4613/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>
  408. </span>
  409. <span class="small pull-right mobile-hide">
  410. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Loader/PluginManager.cs/#L55">View Source</a>
  411. </span>
  412. <a id="IPA_Loader_PluginManager_GetPluginFromId_" data-uid="IPA.Loader.PluginManager.GetPluginFromId*"></a>
  413. <h4 id="IPA_Loader_PluginManager_GetPluginFromId_System_String_" data-uid="IPA.Loader.PluginManager.GetPluginFromId(System.String)">GetPluginFromId(String)</h4>
  414. <div class="markdown level1 summary"><p>Gets info about the enabled plugin with the specified ID.</p>
  415. </div>
  416. <div class="markdown level1 conceptual"></div>
  417. <h5 class="decalaration">Declaration</h5>
  418. <div class="codewrapper">
  419. <pre><code class="lang-csharp hljs">public static PluginMetadata GetPluginFromId(string id)</code></pre>
  420. </div>
  421. <h5 class="parameters">Parameters</h5>
  422. <table class="table table-bordered table-striped table-condensed">
  423. <thead>
  424. <tr>
  425. <th>Type</th>
  426. <th>Name</th>
  427. <th>Description</th>
  428. </tr>
  429. </thead>
  430. <tbody>
  431. <tr>
  432. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  433. <td><span class="parametername">id</span></td>
  434. <td><p>the ID name of the plugin to get (must be an exact match)</p>
  435. </td>
  436. </tr>
  437. </tbody>
  438. </table>
  439. <h5 class="returns">Returns</h5>
  440. <table class="table table-bordered table-striped table-condensed">
  441. <thead>
  442. <tr>
  443. <th>Type</th>
  444. <th>Description</th>
  445. </tr>
  446. </thead>
  447. <tbody>
  448. <tr>
  449. <td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td>
  450. <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>
  451. </td>
  452. </tr>
  453. </tbody>
  454. </table>
  455. <span class="small pull-right mobile-hide">
  456. <span class="divider">|</span>
  457. <a href="https://github.com/nike4613/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>
  458. </span>
  459. <span class="small pull-right mobile-hide">
  460. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Loader/PluginManager.cs/#L254">View Source</a>
  461. </span>
  462. <a id="IPA_Loader_PluginManager_IsDisabled_" data-uid="IPA.Loader.PluginManager.IsDisabled*"></a>
  463. <h4 id="IPA_Loader_PluginManager_IsDisabled_IPA_Loader_PluginMetadata_" data-uid="IPA.Loader.PluginManager.IsDisabled(IPA.Loader.PluginMetadata)">IsDisabled(PluginMetadata)</h4>
  464. <div class="markdown level1 summary"><p>Checks if a given plugin is disabled.</p>
  465. </div>
  466. <div class="markdown level1 conceptual"></div>
  467. <h5 class="decalaration">Declaration</h5>
  468. <div class="codewrapper">
  469. <pre><code class="lang-csharp hljs">public static bool IsDisabled(PluginMetadata meta)</code></pre>
  470. </div>
  471. <h5 class="parameters">Parameters</h5>
  472. <table class="table table-bordered table-striped table-condensed">
  473. <thead>
  474. <tr>
  475. <th>Type</th>
  476. <th>Name</th>
  477. <th>Description</th>
  478. </tr>
  479. </thead>
  480. <tbody>
  481. <tr>
  482. <td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td>
  483. <td><span class="parametername">meta</span></td>
  484. <td><p>the plugin to check</p>
  485. </td>
  486. </tr>
  487. </tbody>
  488. </table>
  489. <h5 class="returns">Returns</h5>
  490. <table class="table table-bordered table-striped table-condensed">
  491. <thead>
  492. <tr>
  493. <th>Type</th>
  494. <th>Description</th>
  495. </tr>
  496. </thead>
  497. <tbody>
  498. <tr>
  499. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  500. <td><p><span class="xref">true</span> if the plugin is disabled, <span class="xref">false</span> otherwise.</p>
  501. </td>
  502. </tr>
  503. </tbody>
  504. </table>
  505. <span class="small pull-right mobile-hide">
  506. <span class="divider">|</span>
  507. <a href="https://github.com/nike4613/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>
  508. </span>
  509. <span class="small pull-right mobile-hide">
  510. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Loader/PluginManager.cs/#L261">View Source</a>
  511. </span>
  512. <a id="IPA_Loader_PluginManager_IsEnabled_" data-uid="IPA.Loader.PluginManager.IsEnabled*"></a>
  513. <h4 id="IPA_Loader_PluginManager_IsEnabled_IPA_Loader_PluginMetadata_" data-uid="IPA.Loader.PluginManager.IsEnabled(IPA.Loader.PluginMetadata)">IsEnabled(PluginMetadata)</h4>
  514. <div class="markdown level1 summary"><p>Checks if a given plugin is enabled.</p>
  515. </div>
  516. <div class="markdown level1 conceptual"></div>
  517. <h5 class="decalaration">Declaration</h5>
  518. <div class="codewrapper">
  519. <pre><code class="lang-csharp hljs">public static bool IsEnabled(PluginMetadata meta)</code></pre>
  520. </div>
  521. <h5 class="parameters">Parameters</h5>
  522. <table class="table table-bordered table-striped table-condensed">
  523. <thead>
  524. <tr>
  525. <th>Type</th>
  526. <th>Name</th>
  527. <th>Description</th>
  528. </tr>
  529. </thead>
  530. <tbody>
  531. <tr>
  532. <td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td>
  533. <td><span class="parametername">meta</span></td>
  534. <td><p>the plugin to check</p>
  535. </td>
  536. </tr>
  537. </tbody>
  538. </table>
  539. <h5 class="returns">Returns</h5>
  540. <table class="table table-bordered table-striped table-condensed">
  541. <thead>
  542. <tr>
  543. <th>Type</th>
  544. <th>Description</th>
  545. </tr>
  546. </thead>
  547. <tbody>
  548. <tr>
  549. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  550. <td><p><span class="xref">true</span> if the plugin is enabled, <span class="xref">false</span> otherwise.</p>
  551. </td>
  552. </tr>
  553. </tbody>
  554. </table>
  555. <span class="small pull-right mobile-hide">
  556. <span class="divider">|</span>
  557. <a href="https://github.com/nike4613/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>
  558. </span>
  559. <span class="small pull-right mobile-hide">
  560. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Loader/PluginManager.cs/#L78">View Source</a>
  561. </span>
  562. <a id="IPA_Loader_PluginManager_PluginStateTransaction_" data-uid="IPA.Loader.PluginManager.PluginStateTransaction*"></a>
  563. <h4 id="IPA_Loader_PluginManager_PluginStateTransaction" data-uid="IPA.Loader.PluginManager.PluginStateTransaction">PluginStateTransaction()</h4>
  564. <div class="markdown level1 summary"><p>Creates a new transaction for mod enabling and disabling mods simultaneously.</p>
  565. </div>
  566. <div class="markdown level1 conceptual"></div>
  567. <h5 class="decalaration">Declaration</h5>
  568. <div class="codewrapper">
  569. <pre><code class="lang-csharp hljs">public static StateTransitionTransaction PluginStateTransaction()</code></pre>
  570. </div>
  571. <h5 class="returns">Returns</h5>
  572. <table class="table table-bordered table-striped table-condensed">
  573. <thead>
  574. <tr>
  575. <th>Type</th>
  576. <th>Description</th>
  577. </tr>
  578. </thead>
  579. <tbody>
  580. <tr>
  581. <td><a class="xref" href="IPA.Loader.StateTransitionTransaction.html">StateTransitionTransaction</a></td>
  582. <td><p>a new <a class="xref" href="IPA.Loader.StateTransitionTransaction.html">StateTransitionTransaction</a> that captures the current state of loaded mods</p>
  583. </td>
  584. </tr>
  585. </tbody>
  586. </table>
  587. <h3 id="events">Events
  588. </h3>
  589. <span class="small pull-right mobile-hide">
  590. <span class="divider">|</span>
  591. <a href="https://github.com/nike4613/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>
  592. </span>
  593. <span class="small pull-right mobile-hide">
  594. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Loader/PluginManager.cs/#L307">View Source</a>
  595. </span>
  596. <h4 id="IPA_Loader_PluginManager_OnAnyPluginsStateChanged" data-uid="IPA.Loader.PluginManager.OnAnyPluginsStateChanged">OnAnyPluginsStateChanged</h4>
  597. <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>
  598. </div>
  599. <div class="markdown level1 conceptual"></div>
  600. <h5 class="decalaration">Declaration</h5>
  601. <div class="codewrapper">
  602. <pre><code class="lang-csharp hljs">public static event PluginManager.OnAnyPluginsStateChangedDelegate OnAnyPluginsStateChanged</code></pre>
  603. </div>
  604. <h5 class="eventType">Event Type</h5>
  605. <table class="table table-bordered table-striped table-condensed">
  606. <thead>
  607. <tr>
  608. <th>Type</th>
  609. <th>Description</th>
  610. </tr>
  611. </thead>
  612. <tbody>
  613. <tr>
  614. <td><a class="xref" href="IPA.Loader.PluginManager.OnAnyPluginsStateChangedDelegate.html">PluginManager.OnAnyPluginsStateChangedDelegate</a></td>
  615. <td></td>
  616. </tr>
  617. </tbody>
  618. </table>
  619. <h5 id="IPA_Loader_PluginManager_OnAnyPluginsStateChanged_remarks">Remarks</h5>
  620. <div class="markdown level1 remarks"><p>Note that this is called on the Unity main thread, and cannot therefore block, as the <see cref="!:Task"></see>
  621. provided represents operations that also run on the Unity main thread.</p>
  622. </div>
  623. <span class="small pull-right mobile-hide">
  624. <span class="divider">|</span>
  625. <a href="https://github.com/nike4613/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>
  626. </span>
  627. <span class="small pull-right mobile-hide">
  628. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Loader/PluginManager.cs/#L299">View Source</a>
  629. </span>
  630. <h4 id="IPA_Loader_PluginManager_OnPluginsStateChanged" data-uid="IPA.Loader.PluginManager.OnPluginsStateChanged">OnPluginsStateChanged</h4>
  631. <div class="markdown level1 summary"><p>Called whenever any plugins have their state changed at runtime with the <see cref="!:Task"></see> representing that state change.</p>
  632. </div>
  633. <div class="markdown level1 conceptual"></div>
  634. <h5 class="decalaration">Declaration</h5>
  635. <div class="codewrapper">
  636. <pre><code class="lang-csharp hljs">public static event Action&lt;Task&gt; OnPluginsStateChanged</code></pre>
  637. </div>
  638. <h5 class="eventType">Event Type</h5>
  639. <table class="table table-bordered table-striped table-condensed">
  640. <thead>
  641. <tr>
  642. <th>Type</th>
  643. <th>Description</th>
  644. </tr>
  645. </thead>
  646. <tbody>
  647. <tr>
  648. <td><span class="xref">Action</span>&lt;<span class="xref">Task</span>&gt;</td>
  649. <td></td>
  650. </tr>
  651. </tbody>
  652. </table>
  653. <h5 id="IPA_Loader_PluginManager_OnPluginsStateChanged_remarks">Remarks</h5>
  654. <div class="markdown level1 remarks"><p>Note that this is called on the Unity main thread, and cannot therefore block, as the <see cref="!:Task"></see>
  655. provided represents operations that also run on the Unity main thread.</p>
  656. </div>
  657. <span class="small pull-right mobile-hide">
  658. <span class="divider">|</span>
  659. <a href="https://github.com/nike4613/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>
  660. </span>
  661. <span class="small pull-right mobile-hide">
  662. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Loader/PluginManager.cs/#L291">View Source</a>
  663. </span>
  664. <h4 id="IPA_Loader_PluginManager_PluginDisabled" data-uid="IPA.Loader.PluginManager.PluginDisabled">PluginDisabled</h4>
  665. <div class="markdown level1 summary"><p>Called whenever a plugin is disabled, before the plugin in question is enabled.</p>
  666. </div>
  667. <div class="markdown level1 conceptual"></div>
  668. <h5 class="decalaration">Declaration</h5>
  669. <div class="codewrapper">
  670. <pre><code class="lang-csharp hljs">public static event PluginManager.PluginDisableDelegate PluginDisabled</code></pre>
  671. </div>
  672. <h5 class="eventType">Event Type</h5>
  673. <table class="table table-bordered table-striped table-condensed">
  674. <thead>
  675. <tr>
  676. <th>Type</th>
  677. <th>Description</th>
  678. </tr>
  679. </thead>
  680. <tbody>
  681. <tr>
  682. <td><a class="xref" href="IPA.Loader.PluginManager.PluginDisableDelegate.html">PluginManager.PluginDisableDelegate</a></td>
  683. <td></td>
  684. </tr>
  685. </tbody>
  686. </table>
  687. <span class="small pull-right mobile-hide">
  688. <span class="divider">|</span>
  689. <a href="https://github.com/nike4613/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>
  690. </span>
  691. <span class="small pull-right mobile-hide">
  692. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Loader/PluginManager.cs/#L287">View Source</a>
  693. </span>
  694. <h4 id="IPA_Loader_PluginManager_PluginEnabled" data-uid="IPA.Loader.PluginManager.PluginEnabled">PluginEnabled</h4>
  695. <div class="markdown level1 summary"><p>Called whenever a plugin is enabled, before the plugin in question is enabled.</p>
  696. </div>
  697. <div class="markdown level1 conceptual"></div>
  698. <h5 class="decalaration">Declaration</h5>
  699. <div class="codewrapper">
  700. <pre><code class="lang-csharp hljs">public static event PluginManager.PluginEnableDelegate PluginEnabled</code></pre>
  701. </div>
  702. <h5 class="eventType">Event Type</h5>
  703. <table class="table table-bordered table-striped table-condensed">
  704. <thead>
  705. <tr>
  706. <th>Type</th>
  707. <th>Description</th>
  708. </tr>
  709. </thead>
  710. <tbody>
  711. <tr>
  712. <td><a class="xref" href="IPA.Loader.PluginManager.PluginEnableDelegate.html">PluginManager.PluginEnableDelegate</a></td>
  713. <td></td>
  714. </tr>
  715. </tbody>
  716. </table>
  717. </article>
  718. </div>
  719. <div class="hidden-sm col-md-2" role="complementary">
  720. <div class="sideaffix">
  721. <div class="contribution">
  722. <ul class="nav">
  723. <li>
  724. <a href="https://github.com/nike4613/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>
  725. </li>
  726. <li>
  727. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Loader/PluginManager.cs/#L35" class="contribution-link">View Source</a>
  728. </li>
  729. </ul>
  730. </div>
  731. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  732. <h5>In This Article</h5>
  733. <div></div>
  734. </nav>
  735. </div>
  736. </div>
  737. </div>
  738. </div>
  739. <footer>
  740. <div class="grad-bottom"></div>
  741. <div class="footer">
  742. <div class="container">
  743. <span class="pull-right">
  744. <a href="#top">Back to top</a>
  745. </span>
  746. <span>Generated by <strong>DocFX</strong></span>
  747. </div>
  748. </div>
  749. </footer>
  750. </div>
  751. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  752. <script type="text/javascript" src="../styles/docfx.js"></script>
  753. <script type="text/javascript" src="../styles/main.js"></script>
  754. </body>
  755. </html>