StationObscurum/Assets/FishNet/Runtime/Managing/Scened/LoadUnloadDatas/UnloadOptions.cs

36 lines
1.3 KiB
C#

namespace FishNet.Managing.Scened
{
/// <summary>
/// Settings to apply when loading a scene.
/// </summary>
public class UnloadOptions
{
/// <summary>
/// Conditions to unloading a scene on the server.
/// </summary>
public enum ServerUnloadMode
{
/// <summary>
/// Unloads the scene if no more connections are within it.
/// </summary>
UnloadUnused = 0,
/// <summary>
/// Unloads scenes for connections but keeps scene loaded on server even if no connections are within it.
/// </summary>
KeepUnused = 1,
}
/// <summary>
/// How to unload scenes on the server. UnloadUnused will unload scenes which have no more clients in them. KeepUnused will not unload a scene even when empty. ForceUnload will unload a scene regardless of if clients are still connected to it.
/// </summary>
[System.NonSerialized]
public ServerUnloadMode Mode = ServerUnloadMode.UnloadUnused;
/// <summary>
/// True if scenes should be loaded using addressables. This field only exists for optional use so the user may know if their queue data is using addressables.
/// </summary>
public bool Addressables;
}
}