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.

762 lines
39 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/d5e463821ab46a106ef48e5537fe0e8709a33aa2/IPA.Loader/Loader/PluginManager.cs/#L294">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><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>
  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/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>
  153. </span>
  154. <span class="small pull-right mobile-hide">
  155. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d5e463821ab46a106ef48e5537fe0e8709a33aa2/IPA.Loader/Loader/PluginManager.cs/#L305">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><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>
  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/beat-saber-modding-group/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/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d5e463821ab46a106ef48e5537fe0e8709a33aa2/IPA.Loader/Loader/PluginManager.cs/#L300">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><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>
  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/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>
  217. </span>
  218. <span class="small pull-right mobile-hide">
  219. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d5e463821ab46a106ef48e5537fe0e8709a33aa2/IPA.Loader/Loader/PluginManager.cs/#L312">View Source</a>
  220. </span>
  221. <a id="IPA_Loader_PluginManager_Plugins_" data-uid="IPA.Loader.PluginManager.Plugins*"></a>
  222. <h4 id="IPA_Loader_PluginManager_Plugins" data-uid="IPA.Loader.PluginManager.Plugins">Plugins</h4>
  223. <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>
  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">[Obsolete(&quot;This exists only to provide support for legacy IPA plugins based on the IPlugin interface.&quot;)]
  229. public static IEnumerable&lt;IPlugin&gt; Plugins { get; }</code></pre>
  230. </div>
  231. <h5 class="propertyValue">Property Value</h5>
  232. <table class="table table-bordered table-striped table-condensed">
  233. <thead>
  234. <tr>
  235. <th>Type</th>
  236. <th>Description</th>
  237. </tr>
  238. </thead>
  239. <tbody>
  240. <tr>
  241. <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>
  242. <td><p>all legacy plugin instances</p>
  243. </td>
  244. </tr>
  245. </tbody>
  246. </table>
  247. <h3 id="methods">Methods
  248. </h3>
  249. <span class="small pull-right mobile-hide">
  250. <span class="divider">|</span>
  251. <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>
  252. </span>
  253. <span class="small pull-right mobile-hide">
  254. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d5e463821ab46a106ef48e5537fe0e8709a33aa2/IPA.Loader/Loader/PluginManager.cs/#L63">View Source</a>
  255. </span>
  256. <a id="IPA_Loader_PluginManager_GetDisabledPlugin_" data-uid="IPA.Loader.PluginManager.GetDisabledPlugin*"></a>
  257. <h4 id="IPA_Loader_PluginManager_GetDisabledPlugin_System_String_" data-uid="IPA.Loader.PluginManager.GetDisabledPlugin(System.String)">GetDisabledPlugin(String)</h4>
  258. <div class="markdown level1 summary"><p>Gets a disabled plugin&apos;s metadata by its name.</p>
  259. </div>
  260. <div class="markdown level1 conceptual"></div>
  261. <h5 class="decalaration">Declaration</h5>
  262. <div class="codewrapper">
  263. <pre><code class="lang-csharp hljs">public static PluginMetadata GetDisabledPlugin(string name)</code></pre>
  264. </div>
  265. <h5 class="parameters">Parameters</h5>
  266. <table class="table table-bordered table-striped table-condensed">
  267. <thead>
  268. <tr>
  269. <th>Type</th>
  270. <th>Name</th>
  271. <th>Description</th>
  272. </tr>
  273. </thead>
  274. <tbody>
  275. <tr>
  276. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  277. <td><span class="parametername">name</span></td>
  278. <td><p>the name of the disabled plugin to get</p>
  279. </td>
  280. </tr>
  281. </tbody>
  282. </table>
  283. <h5 class="returns">Returns</h5>
  284. <table class="table table-bordered table-striped table-condensed">
  285. <thead>
  286. <tr>
  287. <th>Type</th>
  288. <th>Description</th>
  289. </tr>
  290. </thead>
  291. <tbody>
  292. <tr>
  293. <td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td>
  294. <td><p>the metadata for the corresponding plugin</p>
  295. </td>
  296. </tr>
  297. </tbody>
  298. </table>
  299. <span class="small pull-right mobile-hide">
  300. <span class="divider">|</span>
  301. <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>
  302. </span>
  303. <span class="small pull-right mobile-hide">
  304. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d5e463821ab46a106ef48e5537fe0e8709a33aa2/IPA.Loader/Loader/PluginManager.cs/#L71">View Source</a>
  305. </span>
  306. <a id="IPA_Loader_PluginManager_GetDisabledPluginFromId_" data-uid="IPA.Loader.PluginManager.GetDisabledPluginFromId*"></a>
  307. <h4 id="IPA_Loader_PluginManager_GetDisabledPluginFromId_System_String_" data-uid="IPA.Loader.PluginManager.GetDisabledPluginFromId(System.String)">GetDisabledPluginFromId(String)</h4>
  308. <div class="markdown level1 summary"><p>Gets a disabled plugin&apos;s metadata by its ID.</p>
  309. </div>
  310. <div class="markdown level1 conceptual"></div>
  311. <h5 class="decalaration">Declaration</h5>
  312. <div class="codewrapper">
  313. <pre><code class="lang-csharp hljs">public static PluginMetadata GetDisabledPluginFromId(string name)</code></pre>
  314. </div>
  315. <h5 class="parameters">Parameters</h5>
  316. <table class="table table-bordered table-striped table-condensed">
  317. <thead>
  318. <tr>
  319. <th>Type</th>
  320. <th>Name</th>
  321. <th>Description</th>
  322. </tr>
  323. </thead>
  324. <tbody>
  325. <tr>
  326. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  327. <td><span class="parametername">name</span></td>
  328. <td><p>the ID of the disabled plugin to get</p>
  329. </td>
  330. </tr>
  331. </tbody>
  332. </table>
  333. <h5 class="returns">Returns</h5>
  334. <table class="table table-bordered table-striped table-condensed">
  335. <thead>
  336. <tr>
  337. <th>Type</th>
  338. <th>Description</th>
  339. </tr>
  340. </thead>
  341. <tbody>
  342. <tr>
  343. <td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td>
  344. <td><p>the metadata for the corresponding plugin</p>
  345. </td>
  346. </tr>
  347. </tbody>
  348. </table>
  349. <span class="small pull-right mobile-hide">
  350. <span class="divider">|</span>
  351. <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>
  352. </span>
  353. <span class="small pull-right mobile-hide">
  354. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d5e463821ab46a106ef48e5537fe0e8709a33aa2/IPA.Loader/Loader/PluginManager.cs/#L47">View Source</a>
  355. </span>
  356. <a id="IPA_Loader_PluginManager_GetPlugin_" data-uid="IPA.Loader.PluginManager.GetPlugin*"></a>
  357. <h4 id="IPA_Loader_PluginManager_GetPlugin_System_String_" data-uid="IPA.Loader.PluginManager.GetPlugin(System.String)">GetPlugin(String)</h4>
  358. <div class="markdown level1 summary"><p>Gets info about the enabled plugin with the specified name.</p>
  359. </div>
  360. <div class="markdown level1 conceptual"></div>
  361. <h5 class="decalaration">Declaration</h5>
  362. <div class="codewrapper">
  363. <pre><code class="lang-csharp hljs">public static PluginMetadata GetPlugin(string name)</code></pre>
  364. </div>
  365. <h5 class="parameters">Parameters</h5>
  366. <table class="table table-bordered table-striped table-condensed">
  367. <thead>
  368. <tr>
  369. <th>Type</th>
  370. <th>Name</th>
  371. <th>Description</th>
  372. </tr>
  373. </thead>
  374. <tbody>
  375. <tr>
  376. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  377. <td><span class="parametername">name</span></td>
  378. <td><p>the name of the plugin to get (must be an exact match)</p>
  379. </td>
  380. </tr>
  381. </tbody>
  382. </table>
  383. <h5 class="returns">Returns</h5>
  384. <table class="table table-bordered table-striped table-condensed">
  385. <thead>
  386. <tr>
  387. <th>Type</th>
  388. <th>Description</th>
  389. </tr>
  390. </thead>
  391. <tbody>
  392. <tr>
  393. <td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td>
  394. <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>
  395. </td>
  396. </tr>
  397. </tbody>
  398. </table>
  399. <span class="small pull-right mobile-hide">
  400. <span class="divider">|</span>
  401. <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>
  402. </span>
  403. <span class="small pull-right mobile-hide">
  404. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d5e463821ab46a106ef48e5537fe0e8709a33aa2/IPA.Loader/Loader/PluginManager.cs/#L55">View Source</a>
  405. </span>
  406. <a id="IPA_Loader_PluginManager_GetPluginFromId_" data-uid="IPA.Loader.PluginManager.GetPluginFromId*"></a>
  407. <h4 id="IPA_Loader_PluginManager_GetPluginFromId_System_String_" data-uid="IPA.Loader.PluginManager.GetPluginFromId(System.String)">GetPluginFromId(String)</h4>
  408. <div class="markdown level1 summary"><p>Gets info about the enabled plugin with the specified ID.</p>
  409. </div>
  410. <div class="markdown level1 conceptual"></div>
  411. <h5 class="decalaration">Declaration</h5>
  412. <div class="codewrapper">
  413. <pre><code class="lang-csharp hljs">public static PluginMetadata GetPluginFromId(string name)</code></pre>
  414. </div>
  415. <h5 class="parameters">Parameters</h5>
  416. <table class="table table-bordered table-striped table-condensed">
  417. <thead>
  418. <tr>
  419. <th>Type</th>
  420. <th>Name</th>
  421. <th>Description</th>
  422. </tr>
  423. </thead>
  424. <tbody>
  425. <tr>
  426. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  427. <td><span class="parametername">name</span></td>
  428. <td><p>the ID name of the plugin to get (must be an exact match)</p>
  429. </td>
  430. </tr>
  431. </tbody>
  432. </table>
  433. <h5 class="returns">Returns</h5>
  434. <table class="table table-bordered table-striped table-condensed">
  435. <thead>
  436. <tr>
  437. <th>Type</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><p>the plugin metadata for the requested plugin or <span class="xref">null</span> if it doesn&apos;t exist or is disabled</p>
  445. </td>
  446. </tr>
  447. </tbody>
  448. </table>
  449. <span class="small pull-right mobile-hide">
  450. <span class="divider">|</span>
  451. <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>
  452. </span>
  453. <span class="small pull-right mobile-hide">
  454. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d5e463821ab46a106ef48e5537fe0e8709a33aa2/IPA.Loader/Loader/PluginManager.cs/#L235">View Source</a>
  455. </span>
  456. <a id="IPA_Loader_PluginManager_IsDisabled_" data-uid="IPA.Loader.PluginManager.IsDisabled*"></a>
  457. <h4 id="IPA_Loader_PluginManager_IsDisabled_IPA_Loader_PluginMetadata_" data-uid="IPA.Loader.PluginManager.IsDisabled(IPA.Loader.PluginMetadata)">IsDisabled(PluginMetadata)</h4>
  458. <div class="markdown level1 summary"><p>Checks if a given plugin is disabled.</p>
  459. </div>
  460. <div class="markdown level1 conceptual"></div>
  461. <h5 class="decalaration">Declaration</h5>
  462. <div class="codewrapper">
  463. <pre><code class="lang-csharp hljs">public static bool IsDisabled(PluginMetadata meta)</code></pre>
  464. </div>
  465. <h5 class="parameters">Parameters</h5>
  466. <table class="table table-bordered table-striped table-condensed">
  467. <thead>
  468. <tr>
  469. <th>Type</th>
  470. <th>Name</th>
  471. <th>Description</th>
  472. </tr>
  473. </thead>
  474. <tbody>
  475. <tr>
  476. <td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td>
  477. <td><span class="parametername">meta</span></td>
  478. <td><p>the plugin to check</p>
  479. </td>
  480. </tr>
  481. </tbody>
  482. </table>
  483. <h5 class="returns">Returns</h5>
  484. <table class="table table-bordered table-striped table-condensed">
  485. <thead>
  486. <tr>
  487. <th>Type</th>
  488. <th>Description</th>
  489. </tr>
  490. </thead>
  491. <tbody>
  492. <tr>
  493. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  494. <td><p><span class="xref">true</span> if the plugin is disabled, <span class="xref">false</span> otherwise.</p>
  495. </td>
  496. </tr>
  497. </tbody>
  498. </table>
  499. <span class="small pull-right mobile-hide">
  500. <span class="divider">|</span>
  501. <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>
  502. </span>
  503. <span class="small pull-right mobile-hide">
  504. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d5e463821ab46a106ef48e5537fe0e8709a33aa2/IPA.Loader/Loader/PluginManager.cs/#L242">View Source</a>
  505. </span>
  506. <a id="IPA_Loader_PluginManager_IsEnabled_" data-uid="IPA.Loader.PluginManager.IsEnabled*"></a>
  507. <h4 id="IPA_Loader_PluginManager_IsEnabled_IPA_Loader_PluginMetadata_" data-uid="IPA.Loader.PluginManager.IsEnabled(IPA.Loader.PluginMetadata)">IsEnabled(PluginMetadata)</h4>
  508. <div class="markdown level1 summary"><p>Checks if a given plugin is enabled.</p>
  509. </div>
  510. <div class="markdown level1 conceptual"></div>
  511. <h5 class="decalaration">Declaration</h5>
  512. <div class="codewrapper">
  513. <pre><code class="lang-csharp hljs">public static bool IsEnabled(PluginMetadata meta)</code></pre>
  514. </div>
  515. <h5 class="parameters">Parameters</h5>
  516. <table class="table table-bordered table-striped table-condensed">
  517. <thead>
  518. <tr>
  519. <th>Type</th>
  520. <th>Name</th>
  521. <th>Description</th>
  522. </tr>
  523. </thead>
  524. <tbody>
  525. <tr>
  526. <td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td>
  527. <td><span class="parametername">meta</span></td>
  528. <td><p>the plugin to check</p>
  529. </td>
  530. </tr>
  531. </tbody>
  532. </table>
  533. <h5 class="returns">Returns</h5>
  534. <table class="table table-bordered table-striped table-condensed">
  535. <thead>
  536. <tr>
  537. <th>Type</th>
  538. <th>Description</th>
  539. </tr>
  540. </thead>
  541. <tbody>
  542. <tr>
  543. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  544. <td><p><span class="xref">true</span> if the plugin is enabled, <span class="xref">false</span> otherwise.</p>
  545. </td>
  546. </tr>
  547. </tbody>
  548. </table>
  549. <span class="small pull-right mobile-hide">
  550. <span class="divider">|</span>
  551. <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>
  552. </span>
  553. <span class="small pull-right mobile-hide">
  554. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d5e463821ab46a106ef48e5537fe0e8709a33aa2/IPA.Loader/Loader/PluginManager.cs/#L78">View Source</a>
  555. </span>
  556. <a id="IPA_Loader_PluginManager_PluginStateTransaction_" data-uid="IPA.Loader.PluginManager.PluginStateTransaction*"></a>
  557. <h4 id="IPA_Loader_PluginManager_PluginStateTransaction" data-uid="IPA.Loader.PluginManager.PluginStateTransaction">PluginStateTransaction()</h4>
  558. <div class="markdown level1 summary"><p>Creates a new transaction for mod enabling and disabling mods simultaneously.</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 StateTransitionTransaction PluginStateTransaction()</code></pre>
  564. </div>
  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><a class="xref" href="IPA.Loader.StateTransitionTransaction.html">StateTransitionTransaction</a></td>
  576. <td><p>a new <a class="xref" href="IPA.Loader.StateTransitionTransaction.html">StateTransitionTransaction</a> that captures the current state of loaded mods</p>
  577. </td>
  578. </tr>
  579. </tbody>
  580. </table>
  581. <h3 id="events">Events
  582. </h3>
  583. <span class="small pull-right mobile-hide">
  584. <span class="divider">|</span>
  585. <a href="https://github.com/beat-saber-modding-group/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>
  586. </span>
  587. <span class="small pull-right mobile-hide">
  588. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d5e463821ab46a106ef48e5537fe0e8709a33aa2/IPA.Loader/Loader/PluginManager.cs/#L288">View Source</a>
  589. </span>
  590. <h4 id="IPA_Loader_PluginManager_OnAnyPluginsStateChanged" data-uid="IPA.Loader.PluginManager.OnAnyPluginsStateChanged">OnAnyPluginsStateChanged</h4>
  591. <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>
  592. </div>
  593. <div class="markdown level1 conceptual"></div>
  594. <h5 class="decalaration">Declaration</h5>
  595. <div class="codewrapper">
  596. <pre><code class="lang-csharp hljs">public static event PluginManager.OnAnyPluginsStateChangedDelegate OnAnyPluginsStateChanged</code></pre>
  597. </div>
  598. <h5 class="eventType">Event Type</h5>
  599. <table class="table table-bordered table-striped table-condensed">
  600. <thead>
  601. <tr>
  602. <th>Type</th>
  603. <th>Description</th>
  604. </tr>
  605. </thead>
  606. <tbody>
  607. <tr>
  608. <td><a class="xref" href="IPA.Loader.PluginManager.OnAnyPluginsStateChangedDelegate.html">PluginManager.OnAnyPluginsStateChangedDelegate</a></td>
  609. <td></td>
  610. </tr>
  611. </tbody>
  612. </table>
  613. <h5 id="IPA_Loader_PluginManager_OnAnyPluginsStateChanged_remarks">Remarks</h5>
  614. <div class="markdown level1 remarks"><p>Note that this is called on the Unity main thread, and cannot therefore block, as the <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a>
  615. provided represents operations that also run on the Unity main thread.</p>
  616. </div>
  617. <span class="small pull-right mobile-hide">
  618. <span class="divider">|</span>
  619. <a href="https://github.com/beat-saber-modding-group/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>
  620. </span>
  621. <span class="small pull-right mobile-hide">
  622. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d5e463821ab46a106ef48e5537fe0e8709a33aa2/IPA.Loader/Loader/PluginManager.cs/#L280">View Source</a>
  623. </span>
  624. <h4 id="IPA_Loader_PluginManager_OnPluginsStateChanged" data-uid="IPA.Loader.PluginManager.OnPluginsStateChanged">OnPluginsStateChanged</h4>
  625. <div class="markdown level1 summary"><p>Called whenever any plugins have their state changed at runtime with the <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a> representing that state change.</p>
  626. </div>
  627. <div class="markdown level1 conceptual"></div>
  628. <h5 class="decalaration">Declaration</h5>
  629. <div class="codewrapper">
  630. <pre><code class="lang-csharp hljs">public static event Action&lt;Task&gt; OnPluginsStateChanged</code></pre>
  631. </div>
  632. <h5 class="eventType">Event Type</h5>
  633. <table class="table table-bordered table-striped table-condensed">
  634. <thead>
  635. <tr>
  636. <th>Type</th>
  637. <th>Description</th>
  638. </tr>
  639. </thead>
  640. <tbody>
  641. <tr>
  642. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.action-1">Action</a>&lt;<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a>&gt;</td>
  643. <td></td>
  644. </tr>
  645. </tbody>
  646. </table>
  647. <h5 id="IPA_Loader_PluginManager_OnPluginsStateChanged_remarks">Remarks</h5>
  648. <div class="markdown level1 remarks"><p>Note that this is called on the Unity main thread, and cannot therefore block, as the <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a>
  649. provided represents operations that also run on the Unity main thread.</p>
  650. </div>
  651. <span class="small pull-right mobile-hide">
  652. <span class="divider">|</span>
  653. <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>
  654. </span>
  655. <span class="small pull-right mobile-hide">
  656. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d5e463821ab46a106ef48e5537fe0e8709a33aa2/IPA.Loader/Loader/PluginManager.cs/#L272">View Source</a>
  657. </span>
  658. <h4 id="IPA_Loader_PluginManager_PluginDisabled" data-uid="IPA.Loader.PluginManager.PluginDisabled">PluginDisabled</h4>
  659. <div class="markdown level1 summary"><p>Called whenever a plugin is disabled, before the plugin in question is enabled.</p>
  660. </div>
  661. <div class="markdown level1 conceptual"></div>
  662. <h5 class="decalaration">Declaration</h5>
  663. <div class="codewrapper">
  664. <pre><code class="lang-csharp hljs">public static event PluginManager.PluginDisableDelegate PluginDisabled</code></pre>
  665. </div>
  666. <h5 class="eventType">Event Type</h5>
  667. <table class="table table-bordered table-striped table-condensed">
  668. <thead>
  669. <tr>
  670. <th>Type</th>
  671. <th>Description</th>
  672. </tr>
  673. </thead>
  674. <tbody>
  675. <tr>
  676. <td><a class="xref" href="IPA.Loader.PluginManager.PluginDisableDelegate.html">PluginManager.PluginDisableDelegate</a></td>
  677. <td></td>
  678. </tr>
  679. </tbody>
  680. </table>
  681. <span class="small pull-right mobile-hide">
  682. <span class="divider">|</span>
  683. <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>
  684. </span>
  685. <span class="small pull-right mobile-hide">
  686. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d5e463821ab46a106ef48e5537fe0e8709a33aa2/IPA.Loader/Loader/PluginManager.cs/#L268">View Source</a>
  687. </span>
  688. <h4 id="IPA_Loader_PluginManager_PluginEnabled" data-uid="IPA.Loader.PluginManager.PluginEnabled">PluginEnabled</h4>
  689. <div class="markdown level1 summary"><p>Called whenever a plugin is enabled, before the plugin in question is enabled.</p>
  690. </div>
  691. <div class="markdown level1 conceptual"></div>
  692. <h5 class="decalaration">Declaration</h5>
  693. <div class="codewrapper">
  694. <pre><code class="lang-csharp hljs">public static event PluginManager.PluginEnableDelegate PluginEnabled</code></pre>
  695. </div>
  696. <h5 class="eventType">Event Type</h5>
  697. <table class="table table-bordered table-striped table-condensed">
  698. <thead>
  699. <tr>
  700. <th>Type</th>
  701. <th>Description</th>
  702. </tr>
  703. </thead>
  704. <tbody>
  705. <tr>
  706. <td><a class="xref" href="IPA.Loader.PluginManager.PluginEnableDelegate.html">PluginManager.PluginEnableDelegate</a></td>
  707. <td></td>
  708. </tr>
  709. </tbody>
  710. </table>
  711. </article>
  712. </div>
  713. <div class="hidden-sm col-md-2" role="complementary">
  714. <div class="sideaffix">
  715. <div class="contribution">
  716. <ul class="nav">
  717. <li>
  718. <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>
  719. </li>
  720. <li>
  721. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/d5e463821ab46a106ef48e5537fe0e8709a33aa2/IPA.Loader/Loader/PluginManager.cs/#L35" class="contribution-link">View Source</a>
  722. </li>
  723. </ul>
  724. </div>
  725. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  726. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  727. </nav>
  728. </div>
  729. </div>
  730. </div>
  731. </div>
  732. <footer>
  733. <div class="grad-bottom"></div>
  734. <div class="footer">
  735. <div class="container">
  736. <span class="pull-right">
  737. <a href="#top">Back to top</a>
  738. </span>
  739. <span>Generated by <strong>DocFX</strong></span>
  740. </div>
  741. </div>
  742. </footer>
  743. </div>
  744. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  745. <script type="text/javascript" src="../styles/docfx.js"></script>
  746. <script type="text/javascript" src="../styles/main.js"></script>
  747. </body>
  748. </html>