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.

738 lines
37 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 PluginMetadata
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class PluginMetadata
  11. ">
  12. <meta name="generator" content="docfx 2.59.3.0">
  13. <link rel="shortcut icon" href="../favicon.ico">
  14. <link rel="stylesheet" href="../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../styles/docfx.css">
  16. <link rel="stylesheet" href="../styles/main.css">
  17. <link rel="stylesheet" href="../styles/fix.css">
  18. <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
  19. <meta property="docfx:navrel" content="../toc.html">
  20. <meta property="docfx:tocrel" content="toc.html">
  21. <meta property="docfx:rel" content="../">
  22. <meta property="docfx:newtab" content="true">
  23. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  24. <div id="wrapper">
  25. <header>
  26. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  27. <div class="container">
  28. <div class="navbar-header">
  29. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  30. <span class="sr-only">Toggle navigation</span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. <span class="icon-bar"></span>
  34. </button>
  35. <a class="navbar-brand" href="../index.html">
  36. <img id="logo" class="svg" src="../logo.svg" alt="">
  37. </a>
  38. </div>
  39. <div class="collapse navbar-collapse" id="navbar">
  40. <form class="navbar-form navbar-right" role="search" id="search">
  41. <div class="form-group">
  42. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  43. </div>
  44. </form>
  45. </div>
  46. </div>
  47. </nav>
  48. <div class="subnav navbar navbar-default">
  49. <div class="container hide-when-search" id="breadcrumb">
  50. <ul class="breadcrumb">
  51. <li></li>
  52. </ul>
  53. </div>
  54. </div>
  55. </header>
  56. <div class="container body-content">
  57. <div id="search-results">
  58. <div class="search-list">Search Results for <span></span></div>
  59. <div class="sr-items">
  60. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  61. </div>
  62. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  63. </div>
  64. </div>
  65. <div role="main" class="container body-content hide-when-search">
  66. <div class="sidenav hide-when-search">
  67. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  68. <div class="sidetoggle collapse" id="sidetoggle">
  69. <div id="sidetoc"></div>
  70. </div>
  71. </div>
  72. <div class="article row grid-right">
  73. <div class="col-md-10">
  74. <article class="content wrap" id="_content" data-uid="IPA.Loader.PluginMetadata">
  75. <h1 id="IPA_Loader_PluginMetadata" data-uid="IPA.Loader.PluginMetadata" class="text-break">Class PluginMetadata
  76. </h1>
  77. <div class="markdown level0 summary"><p>A class which describes a loaded plugin.</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">PluginMetadata</span></div>
  84. </div>
  85. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Loader.html">IPA.Loader</a></h6>
  86. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  87. <h5 id="IPA_Loader_PluginMetadata_syntax">Syntax</h5>
  88. <div class="codewrapper">
  89. <pre><code class="lang-csharp hljs">public class PluginMetadata : object</code></pre>
  90. </div>
  91. <h3 id="properties">Properties
  92. </h3>
  93. <span class="small pull-right mobile-hide">
  94. <span class="divider">|</span>
  95. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_Assembly.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginMetadata.Assembly%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  96. </span>
  97. <span class="small pull-right mobile-hide">
  98. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Loader/PluginMetadata.cs/#L28">View Source</a>
  99. </span>
  100. <a id="IPA_Loader_PluginMetadata_Assembly_" data-uid="IPA.Loader.PluginMetadata.Assembly*"></a>
  101. <h4 id="IPA_Loader_PluginMetadata_Assembly" data-uid="IPA.Loader.PluginMetadata.Assembly">Assembly</h4>
  102. <div class="markdown level1 summary"><p>The assembly the plugin was loaded from.</p>
  103. </div>
  104. <div class="markdown level1 conceptual"></div>
  105. <h5 class="decalaration">Declaration</h5>
  106. <div class="codewrapper">
  107. <pre><code class="lang-csharp hljs">public Assembly Assembly { get; }</code></pre>
  108. </div>
  109. <h5 class="propertyValue">Property Value</h5>
  110. <table class="table table-bordered table-striped table-condensed">
  111. <thead>
  112. <tr>
  113. <th>Type</th>
  114. <th>Description</th>
  115. </tr>
  116. </thead>
  117. <tbody>
  118. <tr>
  119. <td><span class="xref">Assembly</span></td>
  120. <td><p>the loaded Assembly that contains the plugin main type</p>
  121. </td>
  122. </tr>
  123. </tbody>
  124. </table>
  125. <span class="small pull-right mobile-hide">
  126. <span class="divider">|</span>
  127. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_AssociatedFiles.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginMetadata.AssociatedFiles%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  128. </span>
  129. <span class="small pull-right mobile-hide">
  130. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Loader/PluginMetadata.cs/#L96">View Source</a>
  131. </span>
  132. <a id="IPA_Loader_PluginMetadata_AssociatedFiles_" data-uid="IPA.Loader.PluginMetadata.AssociatedFiles*"></a>
  133. <h4 id="IPA_Loader_PluginMetadata_AssociatedFiles" data-uid="IPA.Loader.PluginMetadata.AssociatedFiles">AssociatedFiles</h4>
  134. <div class="markdown level1 summary"><p>A list of files (that aren&apos;t <a class="xref" href="IPA.Loader.PluginMetadata.html#IPA_Loader_PluginMetadata_File">File</a>) that are associated with this plugin.</p>
  135. </div>
  136. <div class="markdown level1 conceptual"></div>
  137. <h5 class="decalaration">Declaration</h5>
  138. <div class="codewrapper">
  139. <pre><code class="lang-csharp hljs">public IReadOnlyList&lt;FileInfo&gt; AssociatedFiles { get; }</code></pre>
  140. </div>
  141. <h5 class="propertyValue">Property Value</h5>
  142. <table class="table table-bordered table-striped table-condensed">
  143. <thead>
  144. <tr>
  145. <th>Type</th>
  146. <th>Description</th>
  147. </tr>
  148. </thead>
  149. <tbody>
  150. <tr>
  151. <td><span class="xref">IReadOnlyList</span>&lt;<span class="xref">FileInfo</span>&gt;</td>
  152. <td><p>a list of associated files</p>
  153. </td>
  154. </tr>
  155. </tbody>
  156. </table>
  157. <span class="small pull-right mobile-hide">
  158. <span class="divider">|</span>
  159. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_Author.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginMetadata.Author%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  160. </span>
  161. <span class="small pull-right mobile-hide">
  162. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Loader/PluginMetadata.cs/#L52">View Source</a>
  163. </span>
  164. <a id="IPA_Loader_PluginMetadata_Author_" data-uid="IPA.Loader.PluginMetadata.Author*"></a>
  165. <h4 id="IPA_Loader_PluginMetadata_Author" data-uid="IPA.Loader.PluginMetadata.Author">Author</h4>
  166. <div class="markdown level1 summary"><p>The name of the author that wrote this plugin.</p>
  167. </div>
  168. <div class="markdown level1 conceptual"></div>
  169. <h5 class="decalaration">Declaration</h5>
  170. <div class="codewrapper">
  171. <pre><code class="lang-csharp hljs">public string Author { get; }</code></pre>
  172. </div>
  173. <h5 class="propertyValue">Property Value</h5>
  174. <table class="table table-bordered table-striped table-condensed">
  175. <thead>
  176. <tr>
  177. <th>Type</th>
  178. <th>Description</th>
  179. </tr>
  180. </thead>
  181. <tbody>
  182. <tr>
  183. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  184. <td><p>the name of the plugin&apos;s author</p>
  185. </td>
  186. </tr>
  187. </tbody>
  188. </table>
  189. <span class="small pull-right mobile-hide">
  190. <span class="divider">|</span>
  191. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_Description.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginMetadata.Description%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  192. </span>
  193. <span class="small pull-right mobile-hide">
  194. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Loader/PluginMetadata.cs/#L58">View Source</a>
  195. </span>
  196. <a id="IPA_Loader_PluginMetadata_Description_" data-uid="IPA.Loader.PluginMetadata.Description*"></a>
  197. <h4 id="IPA_Loader_PluginMetadata_Description" data-uid="IPA.Loader.PluginMetadata.Description">Description</h4>
  198. <div class="markdown level1 summary"><p>The description of this plugin.</p>
  199. </div>
  200. <div class="markdown level1 conceptual"></div>
  201. <h5 class="decalaration">Declaration</h5>
  202. <div class="codewrapper">
  203. <pre><code class="lang-csharp hljs">public string Description { get; }</code></pre>
  204. </div>
  205. <h5 class="propertyValue">Property Value</h5>
  206. <table class="table table-bordered table-striped table-condensed">
  207. <thead>
  208. <tr>
  209. <th>Type</th>
  210. <th>Description</th>
  211. </tr>
  212. </thead>
  213. <tbody>
  214. <tr>
  215. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  216. <td><p>the description of the plugin</p>
  217. </td>
  218. </tr>
  219. </tbody>
  220. </table>
  221. <span class="small pull-right mobile-hide">
  222. <span class="divider">|</span>
  223. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_DonateLink.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginMetadata.DonateLink%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  224. </span>
  225. <span class="small pull-right mobile-hide">
  226. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Loader/PluginMetadata.cs/#L119">View Source</a>
  227. </span>
  228. <a id="IPA_Loader_PluginMetadata_DonateLink_" data-uid="IPA.Loader.PluginMetadata.DonateLink*"></a>
  229. <h4 id="IPA_Loader_PluginMetadata_DonateLink" data-uid="IPA.Loader.PluginMetadata.DonateLink">DonateLink</h4>
  230. <div class="markdown level1 summary"><p>A link to a donate page for the author of this plugin, if avaliable.</p>
  231. </div>
  232. <div class="markdown level1 conceptual"></div>
  233. <h5 class="decalaration">Declaration</h5>
  234. <div class="codewrapper">
  235. <pre><code class="lang-csharp hljs">public Uri? DonateLink { get; }</code></pre>
  236. </div>
  237. <h5 class="propertyValue">Property Value</h5>
  238. <table class="table table-bordered table-striped table-condensed">
  239. <thead>
  240. <tr>
  241. <th>Type</th>
  242. <th>Description</th>
  243. </tr>
  244. </thead>
  245. <tbody>
  246. <tr>
  247. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.nullable-1">Nullable</a>&lt;<span class="xref">Uri</span>&gt;</td>
  248. <td><p>the <see cref="!:Uri"></see> of the author&apos;s donate page</p>
  249. </td>
  250. </tr>
  251. </tbody>
  252. </table>
  253. <span class="small pull-right mobile-hide">
  254. <span class="divider">|</span>
  255. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_Features.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginMetadata.Features%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>
  256. </span>
  257. <span class="small pull-right mobile-hide">
  258. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Loader/PluginMetadata.cs/#L84">View Source</a>
  259. </span>
  260. <a id="IPA_Loader_PluginMetadata_Features_" data-uid="IPA.Loader.PluginMetadata.Features*"></a>
  261. <h4 id="IPA_Loader_PluginMetadata_Features" data-uid="IPA.Loader.PluginMetadata.Features">Features</h4>
  262. <div class="markdown level1 summary"><p>The features this plugin requests.</p>
  263. </div>
  264. <div class="markdown level1 conceptual"></div>
  265. <h5 class="decalaration">Declaration</h5>
  266. <div class="codewrapper">
  267. <pre><code class="lang-csharp hljs">public IReadOnlyList&lt;Feature&gt; Features { get; }</code></pre>
  268. </div>
  269. <h5 class="propertyValue">Property Value</h5>
  270. <table class="table table-bordered table-striped table-condensed">
  271. <thead>
  272. <tr>
  273. <th>Type</th>
  274. <th>Description</th>
  275. </tr>
  276. </thead>
  277. <tbody>
  278. <tr>
  279. <td><span class="xref">IReadOnlyList</span>&lt;<a class="xref" href="IPA.Loader.Features.Feature.html">Feature</a>&gt;</td>
  280. <td><p>the list of features requested by the plugin</p>
  281. </td>
  282. </tr>
  283. </tbody>
  284. </table>
  285. <span class="small pull-right mobile-hide">
  286. <span class="divider">|</span>
  287. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_File.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginMetadata.File%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>
  288. </span>
  289. <span class="small pull-right mobile-hide">
  290. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Loader/PluginMetadata.cs/#L77">View Source</a>
  291. </span>
  292. <a id="IPA_Loader_PluginMetadata_File_" data-uid="IPA.Loader.PluginMetadata.File*"></a>
  293. <h4 id="IPA_Loader_PluginMetadata_File" data-uid="IPA.Loader.PluginMetadata.File">File</h4>
  294. <div class="markdown level1 summary"><p>The file the plugin was loaded from.</p>
  295. </div>
  296. <div class="markdown level1 conceptual"></div>
  297. <h5 class="decalaration">Declaration</h5>
  298. <div class="codewrapper">
  299. <pre><code class="lang-csharp hljs">public FileInfo File { get; }</code></pre>
  300. </div>
  301. <h5 class="propertyValue">Property Value</h5>
  302. <table class="table table-bordered table-striped table-condensed">
  303. <thead>
  304. <tr>
  305. <th>Type</th>
  306. <th>Description</th>
  307. </tr>
  308. </thead>
  309. <tbody>
  310. <tr>
  311. <td><span class="xref">FileInfo</span></td>
  312. <td><p>the file the plugin was loaded from</p>
  313. </td>
  314. </tr>
  315. </tbody>
  316. </table>
  317. <span class="small pull-right mobile-hide">
  318. <span class="divider">|</span>
  319. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_HVersion.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginMetadata.HVersion%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>
  320. </span>
  321. <span class="small pull-right mobile-hide">
  322. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Loader/PluginMetadata.cs/#L71">View Source</a>
  323. </span>
  324. <a id="IPA_Loader_PluginMetadata_HVersion_" data-uid="IPA.Loader.PluginMetadata.HVersion*"></a>
  325. <h4 id="IPA_Loader_PluginMetadata_HVersion" data-uid="IPA.Loader.PluginMetadata.HVersion">HVersion</h4>
  326. <div class="markdown level1 summary"><p>The version of the plugin.</p>
  327. </div>
  328. <div class="markdown level1 conceptual"></div>
  329. <h5 class="decalaration">Declaration</h5>
  330. <div class="codewrapper">
  331. <pre><code class="lang-csharp hljs">public Hive.Versioning.Version HVersion { get; }</code></pre>
  332. </div>
  333. <h5 class="propertyValue">Property Value</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><span class="xref">Hive.Versioning.Version</span></td>
  344. <td><p>the version of the 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/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_IconName.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginMetadata.IconName%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/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Loader/PluginMetadata.cs/#L102">View Source</a>
  355. </span>
  356. <a id="IPA_Loader_PluginMetadata_IconName_" data-uid="IPA.Loader.PluginMetadata.IconName*"></a>
  357. <h4 id="IPA_Loader_PluginMetadata_IconName" data-uid="IPA.Loader.PluginMetadata.IconName">IconName</h4>
  358. <div class="markdown level1 summary"><p>The name of the resource in the plugin assembly containing the plugin&apos;s icon.</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 string? IconName { get; }</code></pre>
  364. </div>
  365. <h5 class="propertyValue">Property Value</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="https://docs.microsoft.com/dotnet/api/system.nullable-1">Nullable</a>&lt;<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a>&gt;</td>
  376. <td><p>the name of the plugin&apos;s icon</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_PluginMetadata_Id.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginMetadata.Id%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/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Loader/PluginMetadata.cs/#L46">View Source</a>
  387. </span>
  388. <a id="IPA_Loader_PluginMetadata_Id_" data-uid="IPA.Loader.PluginMetadata.Id*"></a>
  389. <h4 id="IPA_Loader_PluginMetadata_Id" data-uid="IPA.Loader.PluginMetadata.Id">Id</h4>
  390. <div class="markdown level1 summary"><p>The ID of the plugin.</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 string Id { get; }</code></pre>
  396. </div>
  397. <h5 class="propertyValue">Property Value</h5>
  398. <table class="table table-bordered table-striped table-condensed">
  399. <thead>
  400. <tr>
  401. <th>Type</th>
  402. <th>Description</th>
  403. </tr>
  404. </thead>
  405. <tbody>
  406. <tr>
  407. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  408. <td><p>the ID of the plugin</p>
  409. </td>
  410. </tr>
  411. </tbody>
  412. </table>
  413. <span class="small pull-right mobile-hide">
  414. <span class="divider">|</span>
  415. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_IsBare.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginMetadata.IsBare%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>
  416. </span>
  417. <span class="small pull-right mobile-hide">
  418. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Loader/PluginMetadata.cs/#L127">View Source</a>
  419. </span>
  420. <a id="IPA_Loader_PluginMetadata_IsBare_" data-uid="IPA.Loader.PluginMetadata.IsBare*"></a>
  421. <h4 id="IPA_Loader_PluginMetadata_IsBare" data-uid="IPA.Loader.PluginMetadata.IsBare">IsBare</h4>
  422. <div class="markdown level1 summary"><p>Whether or not this metadata object represents a bare manifest.</p>
  423. </div>
  424. <div class="markdown level1 conceptual"></div>
  425. <h5 class="decalaration">Declaration</h5>
  426. <div class="codewrapper">
  427. <pre><code class="lang-csharp hljs">public bool IsBare { get; }</code></pre>
  428. </div>
  429. <h5 class="propertyValue">Property Value</h5>
  430. <table class="table table-bordered table-striped table-condensed">
  431. <thead>
  432. <tr>
  433. <th>Type</th>
  434. <th>Description</th>
  435. </tr>
  436. </thead>
  437. <tbody>
  438. <tr>
  439. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  440. <td><p><span class="xref">true</span> if it is bare, <span class="xref">false</span> otherwise</p>
  441. </td>
  442. </tr>
  443. </tbody>
  444. </table>
  445. <span class="small pull-right mobile-hide">
  446. <span class="divider">|</span>
  447. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_Name.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginMetadata.Name%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>
  448. </span>
  449. <span class="small pull-right mobile-hide">
  450. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Loader/PluginMetadata.cs/#L40">View Source</a>
  451. </span>
  452. <a id="IPA_Loader_PluginMetadata_Name_" data-uid="IPA.Loader.PluginMetadata.Name*"></a>
  453. <h4 id="IPA_Loader_PluginMetadata_Name" data-uid="IPA.Loader.PluginMetadata.Name">Name</h4>
  454. <div class="markdown level1 summary"><p>The human readable name of the plugin.</p>
  455. </div>
  456. <div class="markdown level1 conceptual"></div>
  457. <h5 class="decalaration">Declaration</h5>
  458. <div class="codewrapper">
  459. <pre><code class="lang-csharp hljs">public string Name { get; }</code></pre>
  460. </div>
  461. <h5 class="propertyValue">Property Value</h5>
  462. <table class="table table-bordered table-striped table-condensed">
  463. <thead>
  464. <tr>
  465. <th>Type</th>
  466. <th>Description</th>
  467. </tr>
  468. </thead>
  469. <tbody>
  470. <tr>
  471. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  472. <td><p>the name of the plugin</p>
  473. </td>
  474. </tr>
  475. </tbody>
  476. </table>
  477. <span class="small pull-right mobile-hide">
  478. <span class="divider">|</span>
  479. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_PluginHomeLink.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginMetadata.PluginHomeLink%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>
  480. </span>
  481. <span class="small pull-right mobile-hide">
  482. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Loader/PluginMetadata.cs/#L108">View Source</a>
  483. </span>
  484. <a id="IPA_Loader_PluginMetadata_PluginHomeLink_" data-uid="IPA.Loader.PluginMetadata.PluginHomeLink*"></a>
  485. <h4 id="IPA_Loader_PluginMetadata_PluginHomeLink" data-uid="IPA.Loader.PluginMetadata.PluginHomeLink">PluginHomeLink</h4>
  486. <div class="markdown level1 summary"><p>A link to this plugin&apos;s home page, if any.</p>
  487. </div>
  488. <div class="markdown level1 conceptual"></div>
  489. <h5 class="decalaration">Declaration</h5>
  490. <div class="codewrapper">
  491. <pre><code class="lang-csharp hljs">public Uri? PluginHomeLink { get; }</code></pre>
  492. </div>
  493. <h5 class="propertyValue">Property Value</h5>
  494. <table class="table table-bordered table-striped table-condensed">
  495. <thead>
  496. <tr>
  497. <th>Type</th>
  498. <th>Description</th>
  499. </tr>
  500. </thead>
  501. <tbody>
  502. <tr>
  503. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.nullable-1">Nullable</a>&lt;<span class="xref">Uri</span>&gt;</td>
  504. <td><p>the <see cref="!:Uri"></see> of the plugin&apos;s home page</p>
  505. </td>
  506. </tr>
  507. </tbody>
  508. </table>
  509. <span class="small pull-right mobile-hide">
  510. <span class="divider">|</span>
  511. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_PluginSourceLink.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginMetadata.PluginSourceLink%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>
  512. </span>
  513. <span class="small pull-right mobile-hide">
  514. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Loader/PluginMetadata.cs/#L114">View Source</a>
  515. </span>
  516. <a id="IPA_Loader_PluginMetadata_PluginSourceLink_" data-uid="IPA.Loader.PluginMetadata.PluginSourceLink*"></a>
  517. <h4 id="IPA_Loader_PluginMetadata_PluginSourceLink" data-uid="IPA.Loader.PluginMetadata.PluginSourceLink">PluginSourceLink</h4>
  518. <div class="markdown level1 summary"><p>A link to this plugin&apos;s source code, if avaliable.</p>
  519. </div>
  520. <div class="markdown level1 conceptual"></div>
  521. <h5 class="decalaration">Declaration</h5>
  522. <div class="codewrapper">
  523. <pre><code class="lang-csharp hljs">public Uri? PluginSourceLink { get; }</code></pre>
  524. </div>
  525. <h5 class="propertyValue">Property Value</h5>
  526. <table class="table table-bordered table-striped table-condensed">
  527. <thead>
  528. <tr>
  529. <th>Type</th>
  530. <th>Description</th>
  531. </tr>
  532. </thead>
  533. <tbody>
  534. <tr>
  535. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.nullable-1">Nullable</a>&lt;<span class="xref">Uri</span>&gt;</td>
  536. <td><p>the <see cref="!:Uri"></see> of the plugin&apos;s source code</p>
  537. </td>
  538. </tr>
  539. </tbody>
  540. </table>
  541. <span class="small pull-right mobile-hide">
  542. <span class="divider">|</span>
  543. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_PluginType.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginMetadata.PluginType%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>
  544. </span>
  545. <span class="small pull-right mobile-hide">
  546. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Loader/PluginMetadata.cs/#L34">View Source</a>
  547. </span>
  548. <a id="IPA_Loader_PluginMetadata_PluginType_" data-uid="IPA.Loader.PluginMetadata.PluginType*"></a>
  549. <h4 id="IPA_Loader_PluginMetadata_PluginType" data-uid="IPA.Loader.PluginMetadata.PluginType">PluginType</h4>
  550. <div class="markdown level1 summary"><p>The TypeDefinition for the main type of the plugin.</p>
  551. </div>
  552. <div class="markdown level1 conceptual"></div>
  553. <h5 class="decalaration">Declaration</h5>
  554. <div class="codewrapper">
  555. <pre><code class="lang-csharp hljs">public TypeDefinition? PluginType { get; }</code></pre>
  556. </div>
  557. <h5 class="propertyValue">Property Value</h5>
  558. <table class="table table-bordered table-striped table-condensed">
  559. <thead>
  560. <tr>
  561. <th>Type</th>
  562. <th>Description</th>
  563. </tr>
  564. </thead>
  565. <tbody>
  566. <tr>
  567. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.nullable-1">Nullable</a>&lt;<span class="xref">TypeDefinition</span>&gt;</td>
  568. <td><p>the Cecil definition for the plugin main type</p>
  569. </td>
  570. </tr>
  571. </tbody>
  572. </table>
  573. <span class="small pull-right mobile-hide">
  574. <span class="divider">|</span>
  575. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_RuntimeOptions.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginMetadata.RuntimeOptions%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>
  576. </span>
  577. <span class="small pull-right mobile-hide">
  578. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Loader/PluginMetadata.cs/#L149">View Source</a>
  579. </span>
  580. <a id="IPA_Loader_PluginMetadata_RuntimeOptions_" data-uid="IPA.Loader.PluginMetadata.RuntimeOptions*"></a>
  581. <h4 id="IPA_Loader_PluginMetadata_RuntimeOptions" data-uid="IPA.Loader.PluginMetadata.RuntimeOptions">RuntimeOptions</h4>
  582. <div class="markdown level1 summary"><p>The <a class="xref" href="IPA.RuntimeOptions.html">RuntimeOptions</a> that the plugin specified in its <a class="xref" href="IPA.PluginAttribute.html">PluginAttribute</a>.</p>
  583. </div>
  584. <div class="markdown level1 conceptual"></div>
  585. <h5 class="decalaration">Declaration</h5>
  586. <div class="codewrapper">
  587. <pre><code class="lang-csharp hljs">public RuntimeOptions RuntimeOptions { get; }</code></pre>
  588. </div>
  589. <h5 class="propertyValue">Property Value</h5>
  590. <table class="table table-bordered table-striped table-condensed">
  591. <thead>
  592. <tr>
  593. <th>Type</th>
  594. <th>Description</th>
  595. </tr>
  596. </thead>
  597. <tbody>
  598. <tr>
  599. <td><a class="xref" href="IPA.RuntimeOptions.html">RuntimeOptions</a></td>
  600. <td></td>
  601. </tr>
  602. </tbody>
  603. </table>
  604. <span class="small pull-right mobile-hide">
  605. <span class="divider">|</span>
  606. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_Version.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginMetadata.Version%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>
  607. </span>
  608. <span class="small pull-right mobile-hide">
  609. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Loader/PluginMetadata.cs/#L64">View Source</a>
  610. </span>
  611. <a id="IPA_Loader_PluginMetadata_Version_" data-uid="IPA.Loader.PluginMetadata.Version*"></a>
  612. <h4 id="IPA_Loader_PluginMetadata_Version" data-uid="IPA.Loader.PluginMetadata.Version">Version</h4>
  613. <div class="markdown level1 summary"><p>The version of the plugin.</p>
  614. </div>
  615. <div class="markdown level1 conceptual"></div>
  616. <h5 class="decalaration">Declaration</h5>
  617. <div class="codewrapper">
  618. <pre><code class="lang-csharp hljs">public Version Version { get; }</code></pre>
  619. </div>
  620. <h5 class="propertyValue">Property Value</h5>
  621. <table class="table table-bordered table-striped table-condensed">
  622. <thead>
  623. <tr>
  624. <th>Type</th>
  625. <th>Description</th>
  626. </tr>
  627. </thead>
  628. <tbody>
  629. <tr>
  630. <td><a class="xref" href="SemVer.Version.html">Version</a></td>
  631. <td><p>the version of the plugin</p>
  632. </td>
  633. </tr>
  634. </tbody>
  635. </table>
  636. <h3 id="methods">Methods
  637. </h3>
  638. <span class="small pull-right mobile-hide">
  639. <span class="divider">|</span>
  640. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_ToString.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginMetadata.ToString%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>
  641. </span>
  642. <span class="small pull-right mobile-hide">
  643. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Loader/PluginMetadata.cs/#L155">View Source</a>
  644. </span>
  645. <a id="IPA_Loader_PluginMetadata_ToString_" data-uid="IPA.Loader.PluginMetadata.ToString*"></a>
  646. <h4 id="IPA_Loader_PluginMetadata_ToString" data-uid="IPA.Loader.PluginMetadata.ToString">ToString()</h4>
  647. <div class="markdown level1 summary"><p>Gets all of the metadata as a readable string.</p>
  648. </div>
  649. <div class="markdown level1 conceptual"></div>
  650. <h5 class="decalaration">Declaration</h5>
  651. <div class="codewrapper">
  652. <pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
  653. </div>
  654. <h5 class="returns">Returns</h5>
  655. <table class="table table-bordered table-striped table-condensed">
  656. <thead>
  657. <tr>
  658. <th>Type</th>
  659. <th>Description</th>
  660. </tr>
  661. </thead>
  662. <tbody>
  663. <tr>
  664. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  665. <td><p>the readable printable metadata string</p>
  666. </td>
  667. </tr>
  668. </tbody>
  669. </table>
  670. <h3 id="extensionmethods">Extension Methods</h3>
  671. <div>
  672. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetField__2___0_System_String___1_">ReflectionUtil.SetField&lt;T, U&gt;(T, String, U)</a>
  673. </div>
  674. <div>
  675. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetField__2___1_System_String_">ReflectionUtil.GetField&lt;U, T&gt;(T, String)</a>
  676. </div>
  677. <div>
  678. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetProperty__2___0_System_String___1_">ReflectionUtil.SetProperty&lt;T, U&gt;(T, String, U)</a>
  679. </div>
  680. <div>
  681. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetProperty__2___1_System_String_">ReflectionUtil.GetProperty&lt;U, T&gt;(T, String)</a>
  682. </div>
  683. <div>
  684. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__2___1_System_String_System_Object___">ReflectionUtil.InvokeMethod&lt;U, T&gt;(T, String, Object[])</a>
  685. </div>
  686. </article>
  687. </div>
  688. <div class="hidden-sm col-md-2" role="complementary">
  689. <div class="sideaffix">
  690. <div class="contribution">
  691. <ul class="nav">
  692. <li>
  693. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata.md&amp;value=---%0Auid%3A%20IPA.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" class="contribution-link">Improve this Doc</a>
  694. </li>
  695. <li>
  696. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Loader/PluginMetadata.cs/#L22" class="contribution-link">View Source</a>
  697. </li>
  698. </ul>
  699. </div>
  700. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  701. <h5>In This Article</h5>
  702. <div></div>
  703. </nav>
  704. </div>
  705. </div>
  706. </div>
  707. </div>
  708. <footer>
  709. <div class="grad-bottom"></div>
  710. <div class="footer">
  711. <div class="container">
  712. <span class="pull-right">
  713. <a href="#top">Back to top</a>
  714. </span>
  715. <span>Generated by <strong>DocFX</strong></span>
  716. </div>
  717. </div>
  718. </footer>
  719. </div>
  720. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  721. <script type="text/javascript" src="../styles/docfx.js"></script>
  722. <script type="text/javascript" src="../styles/main.js"></script>
  723. </body>
  724. </html>