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.

504 lines
25 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.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.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. <div class="inheritedMembers">
  86. <h5>Inherited Members</h5>
  87. <div>
  88. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_">Object.Equals(Object)</a>
  89. </div>
  90. <div>
  91. <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>
  92. </div>
  93. <div>
  94. <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>
  95. </div>
  96. <div>
  97. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#System_Object_GetHashCode">Object.GetHashCode()</a>
  98. </div>
  99. <div>
  100. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#System_Object_GetType">Object.GetType()</a>
  101. </div>
  102. <div>
  103. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#System_Object_MemberwiseClone">Object.MemberwiseClone()</a>
  104. </div>
  105. </div>
  106. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Loader.html">IPA.Loader</a></h6>
  107. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  108. <h5 id="IPA_Loader_PluginMetadata_syntax">Syntax</h5>
  109. <div class="codewrapper">
  110. <pre><code class="lang-csharp hljs">public class PluginMetadata</code></pre>
  111. </div>
  112. <h3 id="properties">Properties
  113. </h3>
  114. <span class="small pull-right mobile-hide">
  115. <span class="divider">|</span>
  116. <a href="https://github.com/beat-saber-modding-group/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>
  117. </span>
  118. <span class="small pull-right mobile-hide">
  119. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/0d4317e21e35b308dcb31fb7c622d6c89d2d069c/IPA.Loader/Loader/PluginMetadata.cs/#L23">View Source</a>
  120. </span>
  121. <a id="IPA_Loader_PluginMetadata_Assembly_" data-uid="IPA.Loader.PluginMetadata.Assembly*"></a>
  122. <h4 id="IPA_Loader_PluginMetadata_Assembly" data-uid="IPA.Loader.PluginMetadata.Assembly">Assembly</h4>
  123. <div class="markdown level1 summary"><p>The assembly the plugin was loaded from.</p>
  124. </div>
  125. <div class="markdown level1 conceptual"></div>
  126. <h5 class="decalaration">Declaration</h5>
  127. <div class="codewrapper">
  128. <pre><code class="lang-csharp hljs">public Assembly Assembly { get; }</code></pre>
  129. </div>
  130. <h5 class="propertyValue">Property Value</h5>
  131. <table class="table table-bordered table-striped table-condensed">
  132. <thead>
  133. <tr>
  134. <th>Type</th>
  135. <th>Description</th>
  136. </tr>
  137. </thead>
  138. <tbody>
  139. <tr>
  140. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.reflection.assembly">Assembly</a></td>
  141. <td><p>the loaded Assembly that contains the plugin main type</p>
  142. </td>
  143. </tr>
  144. </tbody>
  145. </table>
  146. <span class="small pull-right mobile-hide">
  147. <span class="divider">|</span>
  148. <a href="https://github.com/beat-saber-modding-group/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>
  149. </span>
  150. <span class="small pull-right mobile-hide">
  151. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/0d4317e21e35b308dcb31fb7c622d6c89d2d069c/IPA.Loader/Loader/PluginMetadata.cs/#L60">View Source</a>
  152. </span>
  153. <a id="IPA_Loader_PluginMetadata_Features_" data-uid="IPA.Loader.PluginMetadata.Features*"></a>
  154. <h4 id="IPA_Loader_PluginMetadata_Features" data-uid="IPA.Loader.PluginMetadata.Features">Features</h4>
  155. <div class="markdown level1 summary"><p>The features this plugin requests.</p>
  156. </div>
  157. <div class="markdown level1 conceptual"></div>
  158. <h5 class="decalaration">Declaration</h5>
  159. <div class="codewrapper">
  160. <pre><code class="lang-csharp hljs">public IReadOnlyList&lt;Feature&gt; Features { get; }</code></pre>
  161. </div>
  162. <h5 class="propertyValue">Property Value</h5>
  163. <table class="table table-bordered table-striped table-condensed">
  164. <thead>
  165. <tr>
  166. <th>Type</th>
  167. <th>Description</th>
  168. </tr>
  169. </thead>
  170. <tbody>
  171. <tr>
  172. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.ireadonlylist-1">IReadOnlyList</a>&lt;<a class="xref" href="IPA.Loader.Features.Feature.html">Feature</a>&gt;</td>
  173. <td><p>the list of features requested by the plugin</p>
  174. </td>
  175. </tr>
  176. </tbody>
  177. </table>
  178. <span class="small pull-right mobile-hide">
  179. <span class="divider">|</span>
  180. <a href="https://github.com/beat-saber-modding-group/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>
  181. </span>
  182. <span class="small pull-right mobile-hide">
  183. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/0d4317e21e35b308dcb31fb7c622d6c89d2d069c/IPA.Loader/Loader/PluginMetadata.cs/#L53">View Source</a>
  184. </span>
  185. <a id="IPA_Loader_PluginMetadata_File_" data-uid="IPA.Loader.PluginMetadata.File*"></a>
  186. <h4 id="IPA_Loader_PluginMetadata_File" data-uid="IPA.Loader.PluginMetadata.File">File</h4>
  187. <div class="markdown level1 summary"><p>The file the plugin was loaded from.</p>
  188. </div>
  189. <div class="markdown level1 conceptual"></div>
  190. <h5 class="decalaration">Declaration</h5>
  191. <div class="codewrapper">
  192. <pre><code class="lang-csharp hljs">public FileInfo File { get; }</code></pre>
  193. </div>
  194. <h5 class="propertyValue">Property Value</h5>
  195. <table class="table table-bordered table-striped table-condensed">
  196. <thead>
  197. <tr>
  198. <th>Type</th>
  199. <th>Description</th>
  200. </tr>
  201. </thead>
  202. <tbody>
  203. <tr>
  204. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.io.fileinfo">FileInfo</a></td>
  205. <td><p>the file the plugin was loaded from</p>
  206. </td>
  207. </tr>
  208. </tbody>
  209. </table>
  210. <span class="small pull-right mobile-hide">
  211. <span class="divider">|</span>
  212. <a href="https://github.com/beat-saber-modding-group/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>
  213. </span>
  214. <span class="small pull-right mobile-hide">
  215. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/0d4317e21e35b308dcb31fb7c622d6c89d2d069c/IPA.Loader/Loader/PluginMetadata.cs/#L41">View Source</a>
  216. </span>
  217. <a id="IPA_Loader_PluginMetadata_Id_" data-uid="IPA.Loader.PluginMetadata.Id*"></a>
  218. <h4 id="IPA_Loader_PluginMetadata_Id" data-uid="IPA.Loader.PluginMetadata.Id">Id</h4>
  219. <div class="markdown level1 summary"><p>The BeatMods ID of the plugin, or null if it doesn&apos;t have one.</p>
  220. </div>
  221. <div class="markdown level1 conceptual"></div>
  222. <h5 class="decalaration">Declaration</h5>
  223. <div class="codewrapper">
  224. <pre><code class="lang-csharp hljs">public string Id { get; }</code></pre>
  225. </div>
  226. <h5 class="propertyValue">Property Value</h5>
  227. <table class="table table-bordered table-striped table-condensed">
  228. <thead>
  229. <tr>
  230. <th>Type</th>
  231. <th>Description</th>
  232. </tr>
  233. </thead>
  234. <tbody>
  235. <tr>
  236. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  237. <td><p>the updater ID of the plugin</p>
  238. </td>
  239. </tr>
  240. </tbody>
  241. </table>
  242. <span class="small pull-right mobile-hide">
  243. <span class="divider">|</span>
  244. <a href="https://github.com/beat-saber-modding-group/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>
  245. </span>
  246. <span class="small pull-right mobile-hide">
  247. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/0d4317e21e35b308dcb31fb7c622d6c89d2d069c/IPA.Loader/Loader/PluginMetadata.cs/#L70">View Source</a>
  248. </span>
  249. <a id="IPA_Loader_PluginMetadata_IsBare_" data-uid="IPA.Loader.PluginMetadata.IsBare*"></a>
  250. <h4 id="IPA_Loader_PluginMetadata_IsBare" data-uid="IPA.Loader.PluginMetadata.IsBare">IsBare</h4>
  251. <div class="markdown level1 summary"><p>Whether or not this metadata object represents a bare manifest.</p>
  252. </div>
  253. <div class="markdown level1 conceptual"></div>
  254. <h5 class="decalaration">Declaration</h5>
  255. <div class="codewrapper">
  256. <pre><code class="lang-csharp hljs">public bool IsBare { get; }</code></pre>
  257. </div>
  258. <h5 class="propertyValue">Property Value</h5>
  259. <table class="table table-bordered table-striped table-condensed">
  260. <thead>
  261. <tr>
  262. <th>Type</th>
  263. <th>Description</th>
  264. </tr>
  265. </thead>
  266. <tbody>
  267. <tr>
  268. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  269. <td><p><span class="xref">true</span> if it is bare, <span class="xref">false</span> otherwise</p>
  270. </td>
  271. </tr>
  272. </tbody>
  273. </table>
  274. <span class="small pull-right mobile-hide">
  275. <span class="divider">|</span>
  276. <a href="https://github.com/beat-saber-modding-group/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>
  277. </span>
  278. <span class="small pull-right mobile-hide">
  279. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/0d4317e21e35b308dcb31fb7c622d6c89d2d069c/IPA.Loader/Loader/PluginMetadata.cs/#L35">View Source</a>
  280. </span>
  281. <a id="IPA_Loader_PluginMetadata_Name_" data-uid="IPA.Loader.PluginMetadata.Name*"></a>
  282. <h4 id="IPA_Loader_PluginMetadata_Name" data-uid="IPA.Loader.PluginMetadata.Name">Name</h4>
  283. <div class="markdown level1 summary"><p>The human readable name of the plugin.</p>
  284. </div>
  285. <div class="markdown level1 conceptual"></div>
  286. <h5 class="decalaration">Declaration</h5>
  287. <div class="codewrapper">
  288. <pre><code class="lang-csharp hljs">public string Name { get; }</code></pre>
  289. </div>
  290. <h5 class="propertyValue">Property Value</h5>
  291. <table class="table table-bordered table-striped table-condensed">
  292. <thead>
  293. <tr>
  294. <th>Type</th>
  295. <th>Description</th>
  296. </tr>
  297. </thead>
  298. <tbody>
  299. <tr>
  300. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  301. <td><p>the name of the plugin</p>
  302. </td>
  303. </tr>
  304. </tbody>
  305. </table>
  306. <span class="small pull-right mobile-hide">
  307. <span class="divider">|</span>
  308. <a href="https://github.com/beat-saber-modding-group/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>
  309. </span>
  310. <span class="small pull-right mobile-hide">
  311. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/0d4317e21e35b308dcb31fb7c622d6c89d2d069c/IPA.Loader/Loader/PluginMetadata.cs/#L29">View Source</a>
  312. </span>
  313. <a id="IPA_Loader_PluginMetadata_PluginType_" data-uid="IPA.Loader.PluginMetadata.PluginType*"></a>
  314. <h4 id="IPA_Loader_PluginMetadata_PluginType" data-uid="IPA.Loader.PluginMetadata.PluginType">PluginType</h4>
  315. <div class="markdown level1 summary"><p>The TypeDefinition for the main type of the plugin.</p>
  316. </div>
  317. <div class="markdown level1 conceptual"></div>
  318. <h5 class="decalaration">Declaration</h5>
  319. <div class="codewrapper">
  320. <pre><code class="lang-csharp hljs">public TypeDefinition PluginType { get; }</code></pre>
  321. </div>
  322. <h5 class="propertyValue">Property Value</h5>
  323. <table class="table table-bordered table-striped table-condensed">
  324. <thead>
  325. <tr>
  326. <th>Type</th>
  327. <th>Description</th>
  328. </tr>
  329. </thead>
  330. <tbody>
  331. <tr>
  332. <td><span class="xref">TypeDefinition</span></td>
  333. <td><p>the Cecil definition for the plugin main type</p>
  334. </td>
  335. </tr>
  336. </tbody>
  337. </table>
  338. <span class="small pull-right mobile-hide">
  339. <span class="divider">|</span>
  340. <a href="https://github.com/beat-saber-modding-group/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>
  341. </span>
  342. <span class="small pull-right mobile-hide">
  343. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/0d4317e21e35b308dcb31fb7c622d6c89d2d069c/IPA.Loader/Loader/PluginMetadata.cs/#L91">View Source</a>
  344. </span>
  345. <a id="IPA_Loader_PluginMetadata_RuntimeOptions_" data-uid="IPA.Loader.PluginMetadata.RuntimeOptions*"></a>
  346. <h4 id="IPA_Loader_PluginMetadata_RuntimeOptions" data-uid="IPA.Loader.PluginMetadata.RuntimeOptions">RuntimeOptions</h4>
  347. <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>
  348. </div>
  349. <div class="markdown level1 conceptual"></div>
  350. <h5 class="decalaration">Declaration</h5>
  351. <div class="codewrapper">
  352. <pre><code class="lang-csharp hljs">public RuntimeOptions RuntimeOptions { get; }</code></pre>
  353. </div>
  354. <h5 class="propertyValue">Property Value</h5>
  355. <table class="table table-bordered table-striped table-condensed">
  356. <thead>
  357. <tr>
  358. <th>Type</th>
  359. <th>Description</th>
  360. </tr>
  361. </thead>
  362. <tbody>
  363. <tr>
  364. <td><a class="xref" href="IPA.RuntimeOptions.html">RuntimeOptions</a></td>
  365. <td></td>
  366. </tr>
  367. </tbody>
  368. </table>
  369. <span class="small pull-right mobile-hide">
  370. <span class="divider">|</span>
  371. <a href="https://github.com/beat-saber-modding-group/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>
  372. </span>
  373. <span class="small pull-right mobile-hide">
  374. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/0d4317e21e35b308dcb31fb7c622d6c89d2d069c/IPA.Loader/Loader/PluginMetadata.cs/#L47">View Source</a>
  375. </span>
  376. <a id="IPA_Loader_PluginMetadata_Version_" data-uid="IPA.Loader.PluginMetadata.Version*"></a>
  377. <h4 id="IPA_Loader_PluginMetadata_Version" data-uid="IPA.Loader.PluginMetadata.Version">Version</h4>
  378. <div class="markdown level1 summary"><p>The version of the plugin.</p>
  379. </div>
  380. <div class="markdown level1 conceptual"></div>
  381. <h5 class="decalaration">Declaration</h5>
  382. <div class="codewrapper">
  383. <pre><code class="lang-csharp hljs">public SemVer.Version Version { get; }</code></pre>
  384. </div>
  385. <h5 class="propertyValue">Property Value</h5>
  386. <table class="table table-bordered table-striped table-condensed">
  387. <thead>
  388. <tr>
  389. <th>Type</th>
  390. <th>Description</th>
  391. </tr>
  392. </thead>
  393. <tbody>
  394. <tr>
  395. <td><span class="xref">SemVer.Version</span></td>
  396. <td><p>the version of the plugin</p>
  397. </td>
  398. </tr>
  399. </tbody>
  400. </table>
  401. <h3 id="methods">Methods
  402. </h3>
  403. <span class="small pull-right mobile-hide">
  404. <span class="divider">|</span>
  405. <a href="https://github.com/beat-saber-modding-group/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>
  406. </span>
  407. <span class="small pull-right mobile-hide">
  408. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/0d4317e21e35b308dcb31fb7c622d6c89d2d069c/IPA.Loader/Loader/PluginMetadata.cs/#L97">View Source</a>
  409. </span>
  410. <a id="IPA_Loader_PluginMetadata_ToString_" data-uid="IPA.Loader.PluginMetadata.ToString*"></a>
  411. <h4 id="IPA_Loader_PluginMetadata_ToString" data-uid="IPA.Loader.PluginMetadata.ToString">ToString()</h4>
  412. <div class="markdown level1 summary"><p>Gets all of the metadata as a readable string.</p>
  413. </div>
  414. <div class="markdown level1 conceptual"></div>
  415. <h5 class="decalaration">Declaration</h5>
  416. <div class="codewrapper">
  417. <pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
  418. </div>
  419. <h5 class="returns">Returns</h5>
  420. <table class="table table-bordered table-striped table-condensed">
  421. <thead>
  422. <tr>
  423. <th>Type</th>
  424. <th>Description</th>
  425. </tr>
  426. </thead>
  427. <tbody>
  428. <tr>
  429. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  430. <td><p>the readable printable metadata string</p>
  431. </td>
  432. </tr>
  433. </tbody>
  434. </table>
  435. <h5 class="overrides">Overrides</h5>
  436. <div><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#System_Object_ToString">Object.ToString()</a></div>
  437. <h3 id="extensionmethods">Extension Methods</h3>
  438. <div>
  439. <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>
  440. </div>
  441. <div>
  442. <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>
  443. </div>
  444. <div>
  445. <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>
  446. </div>
  447. <div>
  448. <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>
  449. </div>
  450. <div>
  451. <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>
  452. </div>
  453. </article>
  454. </div>
  455. <div class="hidden-sm col-md-2" role="complementary">
  456. <div class="sideaffix">
  457. <div class="contribution">
  458. <ul class="nav">
  459. <li>
  460. <a href="https://github.com/beat-saber-modding-group/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>
  461. </li>
  462. <li>
  463. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/0d4317e21e35b308dcb31fb7c622d6c89d2d069c/IPA.Loader/Loader/PluginMetadata.cs/#L17" class="contribution-link">View Source</a>
  464. </li>
  465. </ul>
  466. </div>
  467. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  468. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  469. </nav>
  470. </div>
  471. </div>
  472. </div>
  473. </div>
  474. <footer>
  475. <div class="grad-bottom"></div>
  476. <div class="footer">
  477. <div class="container">
  478. <span class="pull-right">
  479. <a href="#top">Back to top</a>
  480. </span>
  481. <span>Generated by <strong>DocFX</strong></span>
  482. </div>
  483. </div>
  484. </footer>
  485. </div>
  486. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  487. <script type="text/javascript" src="../styles/docfx.js"></script>
  488. <script type="text/javascript" src="../styles/main.js"></script>
  489. </body>
  490. </html>