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.

381 lines
18 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 BeatSaber
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class BeatSaber
  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. <link href="https://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet">
  18. <meta property="docfx:navrel" content="../toc.html">
  19. <meta property="docfx:tocrel" content="toc.html">
  20. </head> <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.Utilities.BeatSaber">
  63. <h1 id="IPA_Utilities_BeatSaber" data-uid="IPA.Utilities.BeatSaber" class="text-break">Class BeatSaber
  64. </h1>
  65. <div class="markdown level0 summary"><p>Provides some basic utility methods and properties of Beat Saber</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">BeatSaber</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.Utilities.html">IPA.Utilities</a></h6>
  98. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  99. <h5 id="IPA_Utilities_BeatSaber_syntax">Syntax</h5>
  100. <div class="codewrapper">
  101. <pre><code class="lang-csharp hljs">public static class BeatSaber</code></pre>
  102. </div>
  103. <h3 id="properties">Properties
  104. </h3>
  105. <span class="small pull-right mobile-hide">
  106. <span class="divider">|</span>
  107. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Utilities_BeatSaber_GameVersion.md&amp;value=---%0Auid%3A%20IPA.Utilities.BeatSaber.GameVersion%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>
  108. </span>
  109. <span class="small pull-right mobile-hide">
  110. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Utilities/BeatSaber.cs/#L19">View Source</a>
  111. </span>
  112. <a id="IPA_Utilities_BeatSaber_GameVersion_" data-uid="IPA.Utilities.BeatSaber.GameVersion*"></a>
  113. <h4 id="IPA_Utilities_BeatSaber_GameVersion" data-uid="IPA.Utilities.BeatSaber.GameVersion">GameVersion</h4>
  114. <div class="markdown level1 summary"><p>Provides the current game version.</p>
  115. </div>
  116. <div class="markdown level1 conceptual"></div>
  117. <h5 class="decalaration">Declaration</h5>
  118. <div class="codewrapper">
  119. <pre><code class="lang-csharp hljs">public static Version GameVersion { get; }</code></pre>
  120. </div>
  121. <h5 class="propertyValue">Property Value</h5>
  122. <table class="table table-bordered table-striped table-condensed">
  123. <thead>
  124. <tr>
  125. <th>Type</th>
  126. <th>Description</th>
  127. </tr>
  128. </thead>
  129. <tbody>
  130. <tr>
  131. <td><span class="xref">SemVer.Version</span></td>
  132. <td><p>the SemVer version of the game</p>
  133. </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_Utilities_BeatSaber_InstallPath.md&amp;value=---%0Auid%3A%20IPA.Utilities.BeatSaber.InstallPath%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/Utilities/BeatSaber.cs/#L47">View Source</a>
  143. </span>
  144. <a id="IPA_Utilities_BeatSaber_InstallPath_" data-uid="IPA.Utilities.BeatSaber.InstallPath*"></a>
  145. <h4 id="IPA_Utilities_BeatSaber_InstallPath" data-uid="IPA.Utilities.BeatSaber.InstallPath">InstallPath</h4>
  146. <div class="markdown level1 summary"><p>Gets the path to the Beat Saber install directory.</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 static string InstallPath { get; }</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><p>the path of the game install directory</p>
  165. </td>
  166. </tr>
  167. </tbody>
  168. </table>
  169. <span class="small pull-right mobile-hide">
  170. <span class="divider">|</span>
  171. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Utilities_BeatSaber_LibraryPath.md&amp;value=---%0Auid%3A%20IPA.Utilities.BeatSaber.LibraryPath%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>
  172. </span>
  173. <span class="small pull-right mobile-hide">
  174. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Utilities/BeatSaber.cs/#L61">View Source</a>
  175. </span>
  176. <a id="IPA_Utilities_BeatSaber_LibraryPath_" data-uid="IPA.Utilities.BeatSaber.LibraryPath*"></a>
  177. <h4 id="IPA_Utilities_BeatSaber_LibraryPath" data-uid="IPA.Utilities.BeatSaber.LibraryPath">LibraryPath</h4>
  178. <div class="markdown level1 summary"><p>The path to the <code>Libs</code> folder. Use only if necessary.</p>
  179. </div>
  180. <div class="markdown level1 conceptual"></div>
  181. <h5 class="decalaration">Declaration</h5>
  182. <div class="codewrapper">
  183. <pre><code class="lang-csharp hljs">public static string LibraryPath { get; }</code></pre>
  184. </div>
  185. <h5 class="propertyValue">Property Value</h5>
  186. <table class="table table-bordered table-striped table-condensed">
  187. <thead>
  188. <tr>
  189. <th>Type</th>
  190. <th>Description</th>
  191. </tr>
  192. </thead>
  193. <tbody>
  194. <tr>
  195. <td><span class="xref">System.String</span></td>
  196. <td><p>the path to the library directory</p>
  197. </td>
  198. </tr>
  199. </tbody>
  200. </table>
  201. <span class="small pull-right mobile-hide">
  202. <span class="divider">|</span>
  203. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Utilities_BeatSaber_NativeLibraryPath.md&amp;value=---%0Auid%3A%20IPA.Utilities.BeatSaber.NativeLibraryPath%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>
  204. </span>
  205. <span class="small pull-right mobile-hide">
  206. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Utilities/BeatSaber.cs/#L66">View Source</a>
  207. </span>
  208. <a id="IPA_Utilities_BeatSaber_NativeLibraryPath_" data-uid="IPA.Utilities.BeatSaber.NativeLibraryPath*"></a>
  209. <h4 id="IPA_Utilities_BeatSaber_NativeLibraryPath" data-uid="IPA.Utilities.BeatSaber.NativeLibraryPath">NativeLibraryPath</h4>
  210. <div class="markdown level1 summary"><p>The path to the <code>Libs\Native</code> folder. Use only if necessary.</p>
  211. </div>
  212. <div class="markdown level1 conceptual"></div>
  213. <h5 class="decalaration">Declaration</h5>
  214. <div class="codewrapper">
  215. <pre><code class="lang-csharp hljs">public static string NativeLibraryPath { get; }</code></pre>
  216. </div>
  217. <h5 class="propertyValue">Property Value</h5>
  218. <table class="table table-bordered table-striped table-condensed">
  219. <thead>
  220. <tr>
  221. <th>Type</th>
  222. <th>Description</th>
  223. </tr>
  224. </thead>
  225. <tbody>
  226. <tr>
  227. <td><span class="xref">System.String</span></td>
  228. <td><p>the path to the native library directory</p>
  229. </td>
  230. </tr>
  231. </tbody>
  232. </table>
  233. <span class="small pull-right mobile-hide">
  234. <span class="divider">|</span>
  235. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Utilities_BeatSaber_PluginsPath.md&amp;value=---%0Auid%3A%20IPA.Utilities.BeatSaber.PluginsPath%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>
  236. </span>
  237. <span class="small pull-right mobile-hide">
  238. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Utilities/BeatSaber.cs/#L71">View Source</a>
  239. </span>
  240. <a id="IPA_Utilities_BeatSaber_PluginsPath_" data-uid="IPA.Utilities.BeatSaber.PluginsPath*"></a>
  241. <h4 id="IPA_Utilities_BeatSaber_PluginsPath" data-uid="IPA.Utilities.BeatSaber.PluginsPath">PluginsPath</h4>
  242. <div class="markdown level1 summary"><p>The directory to load plugins from.</p>
  243. </div>
  244. <div class="markdown level1 conceptual"></div>
  245. <h5 class="decalaration">Declaration</h5>
  246. <div class="codewrapper">
  247. <pre><code class="lang-csharp hljs">public static string PluginsPath { get; }</code></pre>
  248. </div>
  249. <h5 class="propertyValue">Property Value</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><span class="xref">System.String</span></td>
  260. <td><p>the path to the plugin directory</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/master/apiSpec/new?filename=IPA_Utilities_BeatSaber_ReleaseType.md&amp;value=---%0Auid%3A%20IPA.Utilities.BeatSaber.ReleaseType%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/master/IPA.Loader/Utilities/BeatSaber.cs/#L40">View Source</a>
  271. </span>
  272. <a id="IPA_Utilities_BeatSaber_ReleaseType_" data-uid="IPA.Utilities.BeatSaber.ReleaseType*"></a>
  273. <h4 id="IPA_Utilities_BeatSaber_ReleaseType" data-uid="IPA.Utilities.BeatSaber.ReleaseType">ReleaseType</h4>
  274. <div class="markdown level1 summary"><p>Gets the <a class="xref" href="IPA.Utilities.BeatSaber.Release.html">BeatSaber.Release</a> type of this installation of Beat Saber</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 BeatSaber.Release ReleaseType { get; }</code></pre>
  280. </div>
  281. <h5 class="propertyValue">Property Value</h5>
  282. <table class="table table-bordered table-striped table-condensed">
  283. <thead>
  284. <tr>
  285. <th>Type</th>
  286. <th>Description</th>
  287. </tr>
  288. </thead>
  289. <tbody>
  290. <tr>
  291. <td><a class="xref" href="IPA.Utilities.BeatSaber.Release.html">BeatSaber.Release</a></td>
  292. <td><p>the type of release this is</p>
  293. </td>
  294. </tr>
  295. </tbody>
  296. </table>
  297. <span class="small pull-right mobile-hide">
  298. <span class="divider">|</span>
  299. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Utilities_BeatSaber_UserDataPath.md&amp;value=---%0Auid%3A%20IPA.Utilities.BeatSaber.UserDataPath%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>
  300. </span>
  301. <span class="small pull-right mobile-hide">
  302. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Utilities/BeatSaber.cs/#L76">View Source</a>
  303. </span>
  304. <a id="IPA_Utilities_BeatSaber_UserDataPath_" data-uid="IPA.Utilities.BeatSaber.UserDataPath*"></a>
  305. <h4 id="IPA_Utilities_BeatSaber_UserDataPath" data-uid="IPA.Utilities.BeatSaber.UserDataPath">UserDataPath</h4>
  306. <div class="markdown level1 summary"><p>The path to the <code>UserData</code> folder.</p>
  307. </div>
  308. <div class="markdown level1 conceptual"></div>
  309. <h5 class="decalaration">Declaration</h5>
  310. <div class="codewrapper">
  311. <pre><code class="lang-csharp hljs">public static string UserDataPath { get; }</code></pre>
  312. </div>
  313. <h5 class="propertyValue">Property Value</h5>
  314. <table class="table table-bordered table-striped table-condensed">
  315. <thead>
  316. <tr>
  317. <th>Type</th>
  318. <th>Description</th>
  319. </tr>
  320. </thead>
  321. <tbody>
  322. <tr>
  323. <td><span class="xref">System.String</span></td>
  324. <td><p>the path to the user data directory</p>
  325. </td>
  326. </tr>
  327. </tbody>
  328. </table>
  329. </article>
  330. </div>
  331. <div class="hidden-sm col-md-2" role="complementary">
  332. <div class="sideaffix">
  333. <div class="contribution">
  334. <ul class="nav">
  335. <li>
  336. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Utilities_BeatSaber.md&amp;value=---%0Auid%3A%20IPA.Utilities.BeatSaber%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>
  337. </li>
  338. <li>
  339. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Utilities/BeatSaber.cs/#L12" class="contribution-link">View Source</a>
  340. </li>
  341. </ul>
  342. </div>
  343. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  344. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  345. </nav>
  346. </div>
  347. </div>
  348. </div>
  349. </div>
  350. <footer>
  351. <div class="grad-bottom"></div>
  352. <div class="footer">
  353. <div class="container">
  354. <span class="pull-right">
  355. <a href="#top">Back to top</a>
  356. </span>
  357. <span>Generated by <strong>DocFX</strong></span>
  358. </div>
  359. </div>
  360. </footer>
  361. </div>
  362. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  363. <script type="text/javascript" src="../styles/docfx.js"></script>
  364. <script type="text/javascript" src="../styles/main.js"></script>
  365. </body>
  366. </html>