Class UnloadOptions

Settings to apply when loading a scene.

Inheritance

System.Object

UnloadOptions

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: FishNet.Managing.Scened

Assembly: FishNet.Runtime.dll

Syntax

public class UnloadOptions

Fields

Addressables

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.

Declaration

public bool Addressables

Field Value

Type	Description
System.Boolean

Mode

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.

Declaration

public UnloadOptions.ServerUnloadMode Mode

Field Value

Type	Description
UnloadOptions.ServerUnloadMode