DaNike
/
BeatSaber-IPA-Reloaded
mirror of https://github.com/bsmg/BeatSaber-IPA-Reloaded.git

﻿<!DOCTYPE html><!--[if IE]><![endif]--><html>    <head>    <meta charset="utf-8">    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">    <title>Class UnityGame   </title>    <meta name="viewport" content="width=device-width">    <meta name="title" content="Class UnityGame   ">    <meta name="generator" content="docfx 2.59.4.0">        <link rel="shortcut icon" href="../favicon.ico">    <link rel="stylesheet" href="../styles/docfx.vendor.css">    <link rel="stylesheet" href="../styles/docfx.css">    <link rel="stylesheet" href="../styles/main.css">    <link rel="stylesheet" href="../styles/fix.css">    <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">     <meta property="docfx:navrel" content="../toc.html">    <meta property="docfx:tocrel" content="toc.html">        <meta property="docfx:rel" content="../">    <meta property="docfx:newtab" content="true">  </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">    <div id="wrapper">      <header>                <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">          <div class="container">            <div class="navbar-header">              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">                <span class="sr-only">Toggle navigation</span>                <span class="icon-bar"></span>                <span class="icon-bar"></span>                <span class="icon-bar"></span>              </button>                            <a class="navbar-brand" href="../index.html">                <img id="logo" class="svg" src="../logo.svg" alt="">              </a>            </div>            <div class="collapse navbar-collapse" id="navbar">              <form class="navbar-form navbar-right" role="search" id="search">                <div class="form-group">                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">                </div>              </form>            </div>          </div>        </nav>                <div class="subnav navbar navbar-default">          <div class="container hide-when-search" id="breadcrumb">            <ul class="breadcrumb">              <li></li>            </ul>          </div>        </div>      </header>      <div class="container body-content">                <div id="search-results">          <div class="search-list">Search Results for <span></span></div>          <div class="sr-items">            <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>          </div>          <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>        </div>      </div>      <div role="main" class="container body-content hide-when-search">                <div class="sidenav hide-when-search">          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>          <div class="sidetoggle collapse" id="sidetoggle">            <div id="sidetoc"></div>          </div>        </div>        <div class="article row grid-right">          <div class="col-md-10">            <article class="content wrap" id="_content" data-uid="IPA.Utilities.UnityGame">      <h1 id="IPA_Utilities_UnityGame" data-uid="IPA.Utilities.UnityGame" class="text-break">Class UnityGame  </h1>  <div class="markdown level0 summary"><p>Provides some basic utility methods and properties of Beat Saber</p></div>  <div class="markdown level0 conceptual"></div>  <div class="inheritance">    <h5>Inheritance</h5>    <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">Object</a></div>    <div class="level1"><span class="xref">UnityGame</span></div>  </div>  <div class="inheritedMembers">    <h5>Inherited Members</h5>    <div>      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring#system-object-tostring">Object.ToString()</a>    </div>    <div>      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">Object.Equals(Object)</a>    </div>    <div>      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">Object.Equals(Object, Object)</a>    </div>    <div>      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals#system-object-referenceequals(system-object-system-object)">Object.ReferenceEquals(Object, Object)</a>    </div>    <div>      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode#system-object-gethashcode">Object.GetHashCode()</a>    </div>    <div>      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype#system-object-gettype">Object.GetType()</a>    </div>    <div>      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone#system-object-memberwiseclone">Object.MemberwiseClone()</a>    </div>  </div>  <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Utilities.html">IPA.Utilities</a></h6>  <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>  <h5 id="IPA_Utilities_UnityGame_syntax">Syntax</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public static class UnityGame</code></pre>  </div>  <h3 id="properties">Properties  </h3>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_UnityGame_GameVersion.md&amp;value=---%0Auid%3A%20IPA.Utilities.UnityGame.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>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/80222a6da147bae9b95433ef78d03c5dd581e465/IPA.Loader/Utilities/UnityGame.cs/#L28">View Source</a>  </span>  <a id="IPA_Utilities_UnityGame_GameVersion_" data-uid="IPA.Utilities.UnityGame.GameVersion*"></a>  <h4 id="IPA_Utilities_UnityGame_GameVersion" data-uid="IPA.Utilities.UnityGame.GameVersion">GameVersion</h4>  <div class="markdown level1 summary"><p>Provides the current game version.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public static AlmostVersion GameVersion { get; }</code></pre>  </div>  <h5 class="propertyValue">Property Value</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><a class="xref" href="IPA.Utilities.AlmostVersion.html">AlmostVersion</a></td>        <td><p>the SemVer version of the game</p></td>      </tr>    </tbody>  </table>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_UnityGame_InstallPath.md&amp;value=---%0Auid%3A%20IPA.Utilities.UnityGame.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>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/80222a6da147bae9b95433ef78d03c5dd581e465/IPA.Loader/Utilities/UnityGame.cs/#L139">View Source</a>  </span>  <a id="IPA_Utilities_UnityGame_InstallPath_" data-uid="IPA.Utilities.UnityGame.InstallPath*"></a>  <h4 id="IPA_Utilities_UnityGame_InstallPath" data-uid="IPA.Utilities.UnityGame.InstallPath">InstallPath</h4>  <div class="markdown level1 summary"><p>Gets the path to the game&apos;s install directory.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public static string InstallPath { get; }</code></pre>  </div>  <h5 class="propertyValue">Property Value</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">String</a></td>        <td><p>the path of the game install directory</p></td>      </tr>    </tbody>  </table>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_UnityGame_LibraryPath.md&amp;value=---%0Auid%3A%20IPA.Utilities.UnityGame.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>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/80222a6da147bae9b95433ef78d03c5dd581e465/IPA.Loader/Utilities/UnityGame.cs/#L153">View Source</a>  </span>  <a id="IPA_Utilities_UnityGame_LibraryPath_" data-uid="IPA.Utilities.UnityGame.LibraryPath*"></a>  <h4 id="IPA_Utilities_UnityGame_LibraryPath" data-uid="IPA.Utilities.UnityGame.LibraryPath">LibraryPath</h4>  <div class="markdown level1 summary"><p>The path to the <code>Libs</code> folder. Use only if necessary.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public static string LibraryPath { get; }</code></pre>  </div>  <h5 class="propertyValue">Property Value</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">String</a></td>        <td><p>the path to the library directory</p></td>      </tr>    </tbody>  </table>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_UnityGame_NativeLibraryPath.md&amp;value=---%0Auid%3A%20IPA.Utilities.UnityGame.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>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/80222a6da147bae9b95433ef78d03c5dd581e465/IPA.Loader/Utilities/UnityGame.cs/#L158">View Source</a>  </span>  <a id="IPA_Utilities_UnityGame_NativeLibraryPath_" data-uid="IPA.Utilities.UnityGame.NativeLibraryPath*"></a>  <h4 id="IPA_Utilities_UnityGame_NativeLibraryPath" data-uid="IPA.Utilities.UnityGame.NativeLibraryPath">NativeLibraryPath</h4>  <div class="markdown level1 summary"><p>The path to the <code>Libs\Native</code> folder. Use only if necessary.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public static string NativeLibraryPath { get; }</code></pre>  </div>  <h5 class="propertyValue">Property Value</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">String</a></td>        <td><p>the path to the native library directory</p></td>      </tr>    </tbody>  </table>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_UnityGame_OnMainThread.md&amp;value=---%0Auid%3A%20IPA.Utilities.UnityGame.OnMainThread%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>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/80222a6da147bae9b95433ef78d03c5dd581e465/IPA.Loader/Utilities/UnityGame.cs/#L99">View Source</a>  </span>  <a id="IPA_Utilities_UnityGame_OnMainThread_" data-uid="IPA.Utilities.UnityGame.OnMainThread*"></a>  <h4 id="IPA_Utilities_UnityGame_OnMainThread" data-uid="IPA.Utilities.UnityGame.OnMainThread">OnMainThread</h4>  <div class="markdown level1 summary"><p>Checks if the currently running code is running on the Unity main thread.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public static bool OnMainThread { get; }</code></pre>  </div>  <h5 class="propertyValue">Property Value</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>        <td><p><span class="xref">true</span> if the curent thread is the Unity main thread, <span class="xref">false</span> otherwise</p></td>      </tr>    </tbody>  </table>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_UnityGame_PluginsPath.md&amp;value=---%0Auid%3A%20IPA.Utilities.UnityGame.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>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/80222a6da147bae9b95433ef78d03c5dd581e465/IPA.Loader/Utilities/UnityGame.cs/#L163">View Source</a>  </span>  <a id="IPA_Utilities_UnityGame_PluginsPath_" data-uid="IPA.Utilities.UnityGame.PluginsPath*"></a>  <h4 id="IPA_Utilities_UnityGame_PluginsPath" data-uid="IPA.Utilities.UnityGame.PluginsPath">PluginsPath</h4>  <div class="markdown level1 summary"><p>The directory to load plugins from.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public static string PluginsPath { get; }</code></pre>  </div>  <h5 class="propertyValue">Property Value</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">String</a></td>        <td><p>the path to the plugin directory</p></td>      </tr>    </tbody>  </table>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_UnityGame_ReleaseType.md&amp;value=---%0Auid%3A%20IPA.Utilities.UnityGame.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>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/80222a6da147bae9b95433ef78d03c5dd581e465/IPA.Loader/Utilities/UnityGame.cs/#L132">View Source</a>  </span>  <a id="IPA_Utilities_UnityGame_ReleaseType_" data-uid="IPA.Utilities.UnityGame.ReleaseType*"></a>  <h4 id="IPA_Utilities_UnityGame_ReleaseType" data-uid="IPA.Utilities.UnityGame.ReleaseType">ReleaseType</h4>  <div class="markdown level1 summary"><p>Gets the <a class="xref" href="IPA.Utilities.UnityGame.Release.html">UnityGame.Release</a> type of this installation of Beat Saber</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public static UnityGame.Release ReleaseType { get; }</code></pre>  </div>  <h5 class="propertyValue">Property Value</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><a class="xref" href="IPA.Utilities.UnityGame.Release.html">UnityGame.Release</a></td>        <td><p>the type of release this is</p></td>      </tr>    </tbody>  </table>  <h5 id="IPA_Utilities_UnityGame_ReleaseType_remarks">Remarks</h5>  <div class="markdown level1 remarks"><p>This only gives a</p></div>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_UnityGame_UserDataPath.md&amp;value=---%0Auid%3A%20IPA.Utilities.UnityGame.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>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/80222a6da147bae9b95433ef78d03c5dd581e465/IPA.Loader/Utilities/UnityGame.cs/#L168">View Source</a>  </span>  <a id="IPA_Utilities_UnityGame_UserDataPath_" data-uid="IPA.Utilities.UnityGame.UserDataPath*"></a>  <h4 id="IPA_Utilities_UnityGame_UserDataPath" data-uid="IPA.Utilities.UnityGame.UserDataPath">UserDataPath</h4>  <div class="markdown level1 summary"><p>The path to the <code>UserData</code> folder.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public static string UserDataPath { get; }</code></pre>  </div>  <h5 class="propertyValue">Property Value</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">String</a></td>        <td><p>the path to the user data directory</p></td>      </tr>    </tbody>  </table>  <h3 id="methods">Methods  </h3>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_UnityGame_SwitchToMainThreadAsync.md&amp;value=---%0Auid%3A%20IPA.Utilities.UnityGame.SwitchToMainThreadAsync%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>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/80222a6da147bae9b95433ef78d03c5dd581e465/IPA.Loader/Utilities/UnityGame.cs/#L105">View Source</a>  </span>  <a id="IPA_Utilities_UnityGame_SwitchToMainThreadAsync_" data-uid="IPA.Utilities.UnityGame.SwitchToMainThreadAsync*"></a>  <h4 id="IPA_Utilities_UnityGame_SwitchToMainThreadAsync" data-uid="IPA.Utilities.UnityGame.SwitchToMainThreadAsync">SwitchToMainThreadAsync()</h4>  <div class="markdown level1 summary"><p>Asynchronously switches the current execution context to the Unity main thread.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public static SwitchToUnityMainThreadAwaitable SwitchToMainThreadAsync()</code></pre>  </div>  <h5 class="returns">Returns</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><a class="xref" href="IPA.Utilities.SwitchToUnityMainThreadAwaitable.html">SwitchToUnityMainThreadAwaitable</a></td>        <td><p>An awaitable which causes any following code to execute on the main thread.</p></td>      </tr>    </tbody>  </table></article>          </div>                    <div class="hidden-sm col-md-2" role="complementary">            <div class="sideaffix">              <div class="contribution">                <ul class="nav">                  <li>                    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_UnityGame.md&amp;value=---%0Auid%3A%20IPA.Utilities.UnityGame%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>                  </li>                  <li>                    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/80222a6da147bae9b95433ef78d03c5dd581e465/IPA.Loader/Utilities/UnityGame.cs/#L21" class="contribution-link">View Source</a>                  </li>                </ul>              </div>              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">                <h5>In This Article</h5>                <div></div>              </nav>            </div>          </div>        </div>      </div>            <footer>        <div class="grad-bottom"></div>        <div class="footer">          <div class="container">            <span class="pull-right">              <a href="#top">Back to top</a>            </span>                        <span>Generated by <strong>DocFX</strong></span>          </div>        </div>      </footer>    </div>        <script type="text/javascript" src="../styles/docfx.vendor.js"></script>    <script type="text/javascript" src="../styles/docfx.js"></script>    <script type="text/javascript" src="../styles/main.js"></script>  </body></html>