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.

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