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.

795 lines
39 KiB

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