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.

236 lines
11 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 ModsaberModInfo
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class ModsaberModInfo
  11. ">
  12. <meta name="generator" content="docfx 2.42.4.0">
  13. <link rel="shortcut icon" href="../favicon.ico">
  14. <link rel="stylesheet" href="../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../styles/docfx.css">
  16. <link rel="stylesheet" href="../styles/main.css">
  17. <meta property="docfx:navrel" content="../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. </head>
  20. <body data-spy="scroll" data-target="#affix" data-offset="120">
  21. <div id="wrapper">
  22. <header>
  23. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  24. <div class="container">
  25. <div class="navbar-header">
  26. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  27. <span class="sr-only">Toggle navigation</span>
  28. <span class="icon-bar"></span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. </button>
  32. <a class="navbar-brand" href="../index.html">
  33. <img id="logo" class="svg" src="../logo.svg" alt="">
  34. </a>
  35. </div>
  36. <div class="collapse navbar-collapse" id="navbar">
  37. <form class="navbar-form navbar-right" role="search" id="search">
  38. <div class="form-group">
  39. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  40. </div>
  41. </form>
  42. </div>
  43. </div>
  44. </nav>
  45. <div class="subnav navbar navbar-default">
  46. <div class="container hide-when-search" id="breadcrumb">
  47. <ul class="breadcrumb">
  48. <li></li>
  49. </ul>
  50. </div>
  51. </div>
  52. </header>
  53. <div role="main" class="container body-content hide-when-search">
  54. <div class="sidenav hide-when-search">
  55. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  56. <div class="sidetoggle collapse" id="sidetoggle">
  57. <div id="sidetoc"></div>
  58. </div>
  59. </div>
  60. <div class="article row grid-right">
  61. <div class="col-md-10">
  62. <article class="content wrap" id="_content" data-uid="IPA.ModsaberModInfo">
  63. <h1 id="IPA_ModsaberModInfo" data-uid="IPA.ModsaberModInfo" class="text-break">Class ModsaberModInfo
  64. </h1>
  65. <div class="markdown level0 summary"><p>A class to provide information about a mod on ModSaber.ML</p>
  66. </div>
  67. <div class="markdown level0 conceptual"></div>
  68. <div class="inheritance">
  69. <h5>Inheritance</h5>
  70. <div class="level0"><span class="xref">System.Object</span></div>
  71. <div class="level1"><span class="xref">ModsaberModInfo</span></div>
  72. </div>
  73. <div class="inheritedMembers">
  74. <h5>Inherited Members</h5>
  75. <div>
  76. <span class="xref">System.Object.ToString()</span>
  77. </div>
  78. <div>
  79. <span class="xref">System.Object.Equals(System.Object)</span>
  80. </div>
  81. <div>
  82. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  83. </div>
  84. <div>
  85. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  86. </div>
  87. <div>
  88. <span class="xref">System.Object.GetHashCode()</span>
  89. </div>
  90. <div>
  91. <span class="xref">System.Object.GetType()</span>
  92. </div>
  93. <div>
  94. <span class="xref">System.Object.MemberwiseClone()</span>
  95. </div>
  96. </div>
  97. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.html">IPA</a></h6>
  98. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  99. <h5 id="IPA_ModsaberModInfo_syntax">Syntax</h5>
  100. <div class="codewrapper">
  101. <pre><code class="lang-csharp hljs">[Obsolete(&quot;This is unused, and has been since the manifest was introduced. All functionality is provided by the manifest.&quot;)]
  102. public class ModsaberModInfo</code></pre>
  103. </div>
  104. <h3 id="properties">Properties
  105. </h3>
  106. <span class="small pull-right mobile-hide">
  107. <span class="divider">|</span>
  108. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_ModsaberModInfo_CurrentVersion.md&amp;value=---%0Auid%3A%20IPA.ModsaberModInfo.CurrentVersion%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>
  109. </span>
  110. <span class="small pull-right mobile-hide">
  111. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/PluginInterfaces/BeatSaber/ModsaberModInfo.cs/#L38">View Source</a>
  112. </span>
  113. <a id="IPA_ModsaberModInfo_CurrentVersion_" data-uid="IPA.ModsaberModInfo.CurrentVersion*"></a>
  114. <h4 id="IPA_ModsaberModInfo_CurrentVersion" data-uid="IPA.ModsaberModInfo.CurrentVersion">CurrentVersion</h4>
  115. <div class="markdown level1 summary"><p>The version of the currently installed mod. Used to compare to the version on ModSaber. Should be a valid SemVer version.</p>
  116. </div>
  117. <div class="markdown level1 conceptual"></div>
  118. <h5 class="decalaration">Declaration</h5>
  119. <div class="codewrapper">
  120. <pre><code class="lang-csharp hljs">public string CurrentVersion { get; set; }</code></pre>
  121. </div>
  122. <h5 class="propertyValue">Property Value</h5>
  123. <table class="table table-bordered table-striped table-condensed">
  124. <thead>
  125. <tr>
  126. <th>Type</th>
  127. <th>Description</th>
  128. </tr>
  129. </thead>
  130. <tbody>
  131. <tr>
  132. <td><span class="xref">System.String</span></td>
  133. <td></td>
  134. </tr>
  135. </tbody>
  136. </table>
  137. <span class="small pull-right mobile-hide">
  138. <span class="divider">|</span>
  139. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_ModsaberModInfo_InternalName.md&amp;value=---%0Auid%3A%20IPA.ModsaberModInfo.InternalName%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>
  140. </span>
  141. <span class="small pull-right mobile-hide">
  142. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/PluginInterfaces/BeatSaber/ModsaberModInfo.cs/#L18">View Source</a>
  143. </span>
  144. <a id="IPA_ModsaberModInfo_InternalName_" data-uid="IPA.ModsaberModInfo.InternalName*"></a>
  145. <h4 id="IPA_ModsaberModInfo_InternalName" data-uid="IPA.ModsaberModInfo.InternalName">InternalName</h4>
  146. <div class="markdown level1 summary"><p>The name the mod uses on ModSaber as an identifier.</p>
  147. </div>
  148. <div class="markdown level1 conceptual"></div>
  149. <h5 class="decalaration">Declaration</h5>
  150. <div class="codewrapper">
  151. <pre><code class="lang-csharp hljs">public string InternalName { get; set; }</code></pre>
  152. </div>
  153. <h5 class="propertyValue">Property Value</h5>
  154. <table class="table table-bordered table-striped table-condensed">
  155. <thead>
  156. <tr>
  157. <th>Type</th>
  158. <th>Description</th>
  159. </tr>
  160. </thead>
  161. <tbody>
  162. <tr>
  163. <td><span class="xref">System.String</span></td>
  164. <td></td>
  165. </tr>
  166. </tbody>
  167. </table>
  168. <h3 id="extensionmethods">Extension Methods</h3>
  169. <div>
  170. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateField_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateField(Object, String, Object)</a>
  171. </div>
  172. <div>
  173. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetPrivateField__1_System_Object_System_String_">ReflectionUtil.GetPrivateField&lt;T&gt;(Object, String)</a>
  174. </div>
  175. <div>
  176. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateProperty_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateProperty(Object, String, Object)</a>
  177. </div>
  178. <div>
  179. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokePrivateMethod_System_Object_System_String_System_Object___">ReflectionUtil.InvokePrivateMethod(Object, String, Object[])</a>
  180. </div>
  181. <div>
  182. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokePrivateMethod__1_System_Object_System_String_System_Object___">ReflectionUtil.InvokePrivateMethod&lt;T&gt;(Object, String, Object[])</a>
  183. </div>
  184. </article>
  185. </div>
  186. <div class="hidden-sm col-md-2" role="complementary">
  187. <div class="sideaffix">
  188. <div class="contribution">
  189. <ul class="nav">
  190. <li>
  191. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_ModsaberModInfo.md&amp;value=---%0Auid%3A%20IPA.ModsaberModInfo%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>
  192. </li>
  193. <li>
  194. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/PluginInterfaces/BeatSaber/ModsaberModInfo.cs/#L12" class="contribution-link">View Source</a>
  195. </li>
  196. </ul>
  197. </div>
  198. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  199. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  200. </nav>
  201. </div>
  202. </div>
  203. </div>
  204. </div>
  205. <footer>
  206. <div class="grad-bottom"></div>
  207. <div class="footer">
  208. <div class="container">
  209. <span class="pull-right">
  210. <a href="#top">Back to top</a>
  211. </span>
  212. <span>Generated by <strong>DocFX</strong></span>
  213. </div>
  214. </div>
  215. </footer>
  216. </div>
  217. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  218. <script type="text/javascript" src="../styles/docfx.js"></script>
  219. <script type="text/javascript" src="../styles/main.js"></script>
  220. </body>
  221. </html>