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.

391 lines
19 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.45.0.0">
  13. <link rel="shortcut icon" href="../favicon.ico">
  14. <link rel="stylesheet" href="../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../styles/docfx.css">
  16. <link rel="stylesheet" href="../styles/main.css">
  17. <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
  18. <meta property="docfx:navrel" content="../toc.html">
  19. <meta property="docfx:tocrel" content="toc.html">
  20. <meta property="docfx:rel" content="../">
  21. <meta property="docfx:newtab" content="true">
  22. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  23. <div id="wrapper">
  24. <header>
  25. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  26. <div class="container">
  27. <div class="navbar-header">
  28. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  29. <span class="sr-only">Toggle navigation</span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. </button>
  34. <a class="navbar-brand" href="../index.html">
  35. <img id="logo" class="svg" src="../logo.svg" alt="">
  36. </a>
  37. </div>
  38. <div class="collapse navbar-collapse" id="navbar">
  39. <form class="navbar-form navbar-right" role="search" id="search">
  40. <div class="form-group">
  41. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  42. </div>
  43. </form>
  44. </div>
  45. </div>
  46. </nav>
  47. <div class="subnav navbar navbar-default">
  48. <div class="container hide-when-search" id="breadcrumb">
  49. <ul class="breadcrumb">
  50. <li></li>
  51. </ul>
  52. </div>
  53. </div>
  54. </header>
  55. <div class="container body-content">
  56. <div id="search-results">
  57. <div class="search-list"></div>
  58. <div class="sr-items">
  59. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  60. </div>
  61. <ul id="pagination"></ul>
  62. </div>
  63. </div>
  64. <div role="main" class="container body-content hide-when-search">
  65. <div class="sidenav hide-when-search">
  66. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  67. <div class="sidetoggle collapse" id="sidetoggle">
  68. <div id="sidetoc"></div>
  69. </div>
  70. </div>
  71. <div class="article row grid-right">
  72. <div class="col-md-10">
  73. <article class="content wrap" id="_content" data-uid="IPA.Utilities.BeatSaber">
  74. <h1 id="IPA_Utilities_BeatSaber" data-uid="IPA.Utilities.BeatSaber" class="text-break">Class BeatSaber
  75. </h1>
  76. <div class="markdown level0 summary"><p>Provides some basic utility methods and properties of Beat Saber</p>
  77. </div>
  78. <div class="markdown level0 conceptual"></div>
  79. <div class="inheritance">
  80. <h5>Inheritance</h5>
  81. <div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
  82. <div class="level1"><span class="xref">BeatSaber</span></div>
  83. </div>
  84. <div class="inheritedMembers">
  85. <h5>Inherited Members</h5>
  86. <div>
  87. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#System_Object_ToString">Object.ToString()</a>
  88. </div>
  89. <div>
  90. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_">Object.Equals(Object)</a>
  91. </div>
  92. <div>
  93. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_System_Object_">Object.Equals(Object, Object)</a>
  94. </div>
  95. <div>
  96. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.referenceequals#System_Object_ReferenceEquals_System_Object_System_Object_">Object.ReferenceEquals(Object, Object)</a>
  97. </div>
  98. <div>
  99. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#System_Object_GetHashCode">Object.GetHashCode()</a>
  100. </div>
  101. <div>
  102. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#System_Object_GetType">Object.GetType()</a>
  103. </div>
  104. <div>
  105. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#System_Object_MemberwiseClone">Object.MemberwiseClone()</a>
  106. </div>
  107. </div>
  108. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Utilities.html">IPA.Utilities</a></h6>
  109. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  110. <h5 id="IPA_Utilities_BeatSaber_syntax">Syntax</h5>
  111. <div class="codewrapper">
  112. <pre><code class="lang-csharp hljs">public static class BeatSaber</code></pre>
  113. </div>
  114. <h3 id="properties">Properties
  115. </h3>
  116. <span class="small pull-right mobile-hide">
  117. <span class="divider">|</span>
  118. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  119. </span>
  120. <span class="small pull-right mobile-hide">
  121. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/c57fdfa83eef52955dd90baad18123997d7ec4b9/IPA.Loader/Utilities/BeatSaber.cs/#L22">View Source</a>
  122. </span>
  123. <a id="IPA_Utilities_BeatSaber_GameVersion_" data-uid="IPA.Utilities.BeatSaber.GameVersion*"></a>
  124. <h4 id="IPA_Utilities_BeatSaber_GameVersion" data-uid="IPA.Utilities.BeatSaber.GameVersion">GameVersion</h4>
  125. <div class="markdown level1 summary"><p>Provides the current game version.</p>
  126. </div>
  127. <div class="markdown level1 conceptual"></div>
  128. <h5 class="decalaration">Declaration</h5>
  129. <div class="codewrapper">
  130. <pre><code class="lang-csharp hljs">public static AlmostVersion GameVersion { get; }</code></pre>
  131. </div>
  132. <h5 class="propertyValue">Property Value</h5>
  133. <table class="table table-bordered table-striped table-condensed">
  134. <thead>
  135. <tr>
  136. <th>Type</th>
  137. <th>Description</th>
  138. </tr>
  139. </thead>
  140. <tbody>
  141. <tr>
  142. <td><a class="xref" href="IPA.Utilities.AlmostVersion.html">AlmostVersion</a></td>
  143. <td><p>the SemVer version of the game</p>
  144. </td>
  145. </tr>
  146. </tbody>
  147. </table>
  148. <span class="small pull-right mobile-hide">
  149. <span class="divider">|</span>
  150. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  151. </span>
  152. <span class="small pull-right mobile-hide">
  153. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/c57fdfa83eef52955dd90baad18123997d7ec4b9/IPA.Loader/Utilities/BeatSaber.cs/#L75">View Source</a>
  154. </span>
  155. <a id="IPA_Utilities_BeatSaber_InstallPath_" data-uid="IPA.Utilities.BeatSaber.InstallPath*"></a>
  156. <h4 id="IPA_Utilities_BeatSaber_InstallPath" data-uid="IPA.Utilities.BeatSaber.InstallPath">InstallPath</h4>
  157. <div class="markdown level1 summary"><p>Gets the path to the Beat Saber install directory.</p>
  158. </div>
  159. <div class="markdown level1 conceptual"></div>
  160. <h5 class="decalaration">Declaration</h5>
  161. <div class="codewrapper">
  162. <pre><code class="lang-csharp hljs">public static string InstallPath { get; }</code></pre>
  163. </div>
  164. <h5 class="propertyValue">Property Value</h5>
  165. <table class="table table-bordered table-striped table-condensed">
  166. <thead>
  167. <tr>
  168. <th>Type</th>
  169. <th>Description</th>
  170. </tr>
  171. </thead>
  172. <tbody>
  173. <tr>
  174. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  175. <td><p>the path of the game install directory</p>
  176. </td>
  177. </tr>
  178. </tbody>
  179. </table>
  180. <span class="small pull-right mobile-hide">
  181. <span class="divider">|</span>
  182. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  183. </span>
  184. <span class="small pull-right mobile-hide">
  185. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/c57fdfa83eef52955dd90baad18123997d7ec4b9/IPA.Loader/Utilities/BeatSaber.cs/#L89">View Source</a>
  186. </span>
  187. <a id="IPA_Utilities_BeatSaber_LibraryPath_" data-uid="IPA.Utilities.BeatSaber.LibraryPath*"></a>
  188. <h4 id="IPA_Utilities_BeatSaber_LibraryPath" data-uid="IPA.Utilities.BeatSaber.LibraryPath">LibraryPath</h4>
  189. <div class="markdown level1 summary"><p>The path to the <code>Libs</code> folder. Use only if necessary.</p>
  190. </div>
  191. <div class="markdown level1 conceptual"></div>
  192. <h5 class="decalaration">Declaration</h5>
  193. <div class="codewrapper">
  194. <pre><code class="lang-csharp hljs">public static string LibraryPath { get; }</code></pre>
  195. </div>
  196. <h5 class="propertyValue">Property Value</h5>
  197. <table class="table table-bordered table-striped table-condensed">
  198. <thead>
  199. <tr>
  200. <th>Type</th>
  201. <th>Description</th>
  202. </tr>
  203. </thead>
  204. <tbody>
  205. <tr>
  206. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  207. <td><p>the path to the library directory</p>
  208. </td>
  209. </tr>
  210. </tbody>
  211. </table>
  212. <span class="small pull-right mobile-hide">
  213. <span class="divider">|</span>
  214. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  215. </span>
  216. <span class="small pull-right mobile-hide">
  217. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/c57fdfa83eef52955dd90baad18123997d7ec4b9/IPA.Loader/Utilities/BeatSaber.cs/#L94">View Source</a>
  218. </span>
  219. <a id="IPA_Utilities_BeatSaber_NativeLibraryPath_" data-uid="IPA.Utilities.BeatSaber.NativeLibraryPath*"></a>
  220. <h4 id="IPA_Utilities_BeatSaber_NativeLibraryPath" data-uid="IPA.Utilities.BeatSaber.NativeLibraryPath">NativeLibraryPath</h4>
  221. <div class="markdown level1 summary"><p>The path to the <code>Libs\Native</code> folder. Use only if necessary.</p>
  222. </div>
  223. <div class="markdown level1 conceptual"></div>
  224. <h5 class="decalaration">Declaration</h5>
  225. <div class="codewrapper">
  226. <pre><code class="lang-csharp hljs">public static string NativeLibraryPath { get; }</code></pre>
  227. </div>
  228. <h5 class="propertyValue">Property Value</h5>
  229. <table class="table table-bordered table-striped table-condensed">
  230. <thead>
  231. <tr>
  232. <th>Type</th>
  233. <th>Description</th>
  234. </tr>
  235. </thead>
  236. <tbody>
  237. <tr>
  238. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  239. <td><p>the path to the native library directory</p>
  240. </td>
  241. </tr>
  242. </tbody>
  243. </table>
  244. <span class="small pull-right mobile-hide">
  245. <span class="divider">|</span>
  246. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  247. </span>
  248. <span class="small pull-right mobile-hide">
  249. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/c57fdfa83eef52955dd90baad18123997d7ec4b9/IPA.Loader/Utilities/BeatSaber.cs/#L99">View Source</a>
  250. </span>
  251. <a id="IPA_Utilities_BeatSaber_PluginsPath_" data-uid="IPA.Utilities.BeatSaber.PluginsPath*"></a>
  252. <h4 id="IPA_Utilities_BeatSaber_PluginsPath" data-uid="IPA.Utilities.BeatSaber.PluginsPath">PluginsPath</h4>
  253. <div class="markdown level1 summary"><p>The directory to load plugins from.</p>
  254. </div>
  255. <div class="markdown level1 conceptual"></div>
  256. <h5 class="decalaration">Declaration</h5>
  257. <div class="codewrapper">
  258. <pre><code class="lang-csharp hljs">public static string PluginsPath { get; }</code></pre>
  259. </div>
  260. <h5 class="propertyValue">Property Value</h5>
  261. <table class="table table-bordered table-striped table-condensed">
  262. <thead>
  263. <tr>
  264. <th>Type</th>
  265. <th>Description</th>
  266. </tr>
  267. </thead>
  268. <tbody>
  269. <tr>
  270. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  271. <td><p>the path to the plugin directory</p>
  272. </td>
  273. </tr>
  274. </tbody>
  275. </table>
  276. <span class="small pull-right mobile-hide">
  277. <span class="divider">|</span>
  278. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  279. </span>
  280. <span class="small pull-right mobile-hide">
  281. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/c57fdfa83eef52955dd90baad18123997d7ec4b9/IPA.Loader/Utilities/BeatSaber.cs/#L68">View Source</a>
  282. </span>
  283. <a id="IPA_Utilities_BeatSaber_ReleaseType_" data-uid="IPA.Utilities.BeatSaber.ReleaseType*"></a>
  284. <h4 id="IPA_Utilities_BeatSaber_ReleaseType" data-uid="IPA.Utilities.BeatSaber.ReleaseType">ReleaseType</h4>
  285. <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>
  286. </div>
  287. <div class="markdown level1 conceptual"></div>
  288. <h5 class="decalaration">Declaration</h5>
  289. <div class="codewrapper">
  290. <pre><code class="lang-csharp hljs">public static BeatSaber.Release ReleaseType { get; }</code></pre>
  291. </div>
  292. <h5 class="propertyValue">Property Value</h5>
  293. <table class="table table-bordered table-striped table-condensed">
  294. <thead>
  295. <tr>
  296. <th>Type</th>
  297. <th>Description</th>
  298. </tr>
  299. </thead>
  300. <tbody>
  301. <tr>
  302. <td><a class="xref" href="IPA.Utilities.BeatSaber.Release.html">BeatSaber.Release</a></td>
  303. <td><p>the type of release this is</p>
  304. </td>
  305. </tr>
  306. </tbody>
  307. </table>
  308. <span class="small pull-right mobile-hide">
  309. <span class="divider">|</span>
  310. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  311. </span>
  312. <span class="small pull-right mobile-hide">
  313. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/c57fdfa83eef52955dd90baad18123997d7ec4b9/IPA.Loader/Utilities/BeatSaber.cs/#L104">View Source</a>
  314. </span>
  315. <a id="IPA_Utilities_BeatSaber_UserDataPath_" data-uid="IPA.Utilities.BeatSaber.UserDataPath*"></a>
  316. <h4 id="IPA_Utilities_BeatSaber_UserDataPath" data-uid="IPA.Utilities.BeatSaber.UserDataPath">UserDataPath</h4>
  317. <div class="markdown level1 summary"><p>The path to the <code>UserData</code> folder.</p>
  318. </div>
  319. <div class="markdown level1 conceptual"></div>
  320. <h5 class="decalaration">Declaration</h5>
  321. <div class="codewrapper">
  322. <pre><code class="lang-csharp hljs">public static string UserDataPath { get; }</code></pre>
  323. </div>
  324. <h5 class="propertyValue">Property Value</h5>
  325. <table class="table table-bordered table-striped table-condensed">
  326. <thead>
  327. <tr>
  328. <th>Type</th>
  329. <th>Description</th>
  330. </tr>
  331. </thead>
  332. <tbody>
  333. <tr>
  334. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  335. <td><p>the path to the user data directory</p>
  336. </td>
  337. </tr>
  338. </tbody>
  339. </table>
  340. </article>
  341. </div>
  342. <div class="hidden-sm col-md-2" role="complementary">
  343. <div class="sideaffix">
  344. <div class="contribution">
  345. <ul class="nav">
  346. <li>
  347. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  348. </li>
  349. <li>
  350. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/c57fdfa83eef52955dd90baad18123997d7ec4b9/IPA.Loader/Utilities/BeatSaber.cs/#L15" class="contribution-link">View Source</a>
  351. </li>
  352. </ul>
  353. </div>
  354. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  355. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  356. </nav>
  357. </div>
  358. </div>
  359. </div>
  360. </div>
  361. <footer>
  362. <div class="grad-bottom"></div>
  363. <div class="footer">
  364. <div class="container">
  365. <span class="pull-right">
  366. <a href="#top">Back to top</a>
  367. </span>
  368. <span>Generated by <strong>DocFX</strong></span>
  369. </div>
  370. </div>
  371. </footer>
  372. </div>
  373. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  374. <script type="text/javascript" src="../styles/docfx.js"></script>
  375. <script type="text/javascript" src="../styles/main.js"></script>
  376. </body>
  377. </html>