Class LoadOptions

Settings to apply when loading a scene.

Inheritance
System.Object
LoadOptions
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 LoadOptions

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

AllowStacking

False if to only load scenes which are not yet loaded. When true a scene may load multiple times; this is known as scene stacking. Only the server is able to stack scenes; clients will load a single instance. Global scenes cannot be stacked.

Declaration
[NonSerialized]
public bool AllowStacking
Field Value
Type Description
System.Boolean

AutomaticallyUnload

True if to automatically unload the loaded scenes when they are no longer being used by clients. This field only applies to scenes loaded for connections, not globally loaded scenes.

Declaration
[NonSerialized]
public bool AutomaticallyUnload
Field Value
Type Description
System.Boolean

LocalPhysics

LocalPhysics mode to use when loading this scene. Generally this will only be used when applying scene stacking. Only used by the server. https://docs.unity3d.com/ScriptReference/SceneManagement.LocalPhysicsMode.html

Declaration
[NonSerialized]
public LocalPhysicsMode LocalPhysics
Field Value
Type Description
UnityEngine.SceneManagement.LocalPhysicsMode

ReloadScenes

True to reload a scene if it's already loaded. This does not function yet.

Declaration
[Obsolete("This feature is not functional yet but will be at a later release.")]
public bool ReloadScenes
Field Value
Type Description
System.Boolean