Class UnityGame

Provides some basic utility methods and properties of Beat Saber

Inheritance

Object

UnityGame

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: IPA.Utilities

Assembly: IPA.Loader.dll

Syntax

public static class UnityGame

Properties

GameVersion

Provides the current game version.

Declaration

public static AlmostVersion GameVersion { get; }

Property Value

Type	Description
AlmostVersion	the SemVer version of the game

InstallPath

Gets the path to the game's install directory.

Declaration

public static string InstallPath { get; }

Property Value

Type	Description
String	the path of the game install directory

LibraryPath

The path to the Libs folder. Use only if necessary.

Declaration

public static string LibraryPath { get; }

Property Value

Type	Description
String	the path to the library directory

NativeLibraryPath

The path to the Libs\Native folder. Use only if necessary.

Declaration

public static string NativeLibraryPath { get; }

Property Value

Type	Description
String	the path to the native library directory

OnMainThread

Checks if the currently running code is running on the Unity main thread.

Declaration

public static bool OnMainThread { get; }

Property Value

Type	Description
Boolean	true if the curent thread is the Unity main thread, false otherwise

PluginsPath

The directory to load plugins from.

Declaration

public static string PluginsPath { get; }

Property Value

Type	Description
String	the path to the plugin directory

ReleaseType

Gets the UnityGame.Release type of this installation of Beat Saber

Declaration

public static UnityGame.Release ReleaseType { get; }

Property Value

Type	Description
UnityGame.Release	the type of release this is

Remarks

This only gives a

UserDataPath

The path to the UserData folder.

Declaration

public static string UserDataPath { get; }

Property Value

Type	Description
String	the path to the user data directory

Methods

SwitchToMainThreadAsync()

Asynchronously switches the current execution context to the Unity main thread.

Declaration

public static SwitchToUnityMainThreadAwaitable SwitchToMainThreadAsync()

Returns

Type	Description
SwitchToUnityMainThreadAwaitable	An awaitable which causes any following code to execute on the main thread.