Class SceneLoadData

Data about which scenes to load.

Inheritance

System.Object

SceneLoadData

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 SceneLoadData

Constructors

SceneLoadData()

Declaration

public SceneLoadData()

SceneLoadData(SceneLookupData)

Declaration

public SceneLoadData(SceneLookupData sceneLookupData)

Parameters

Type	Name	Description
SceneLookupData	sceneLookupData	Scene to load by SceneLookupData.

SceneLoadData(SceneLookupData[])

Declaration

public SceneLoadData(SceneLookupData[] sceneLookupDatas)

Parameters

Type	Name	Description
SceneLookupData[]	sceneLookupDatas	Scenes to load by SceneLookupDatas.

SceneLoadData(SceneLookupData[], NetworkObject[])

Declaration

public SceneLoadData(SceneLookupData[] sceneLookupDatas, NetworkObject[] movedNetworkObjects)

Parameters

Type	Name	Description
SceneLookupData[]	sceneLookupDatas	Scenes to load by SceneLookupDatas.
NetworkObject[]	movedNetworkObjects	NetworkObjects to move to the first specified scene.

SceneLoadData(List<Int32>)

Declaration

public SceneLoadData(List<int> sceneHandles)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.Int32>	sceneHandles	Scenes to load by handle.

SceneLoadData(List<String>)

Declaration

public SceneLoadData(List<string> sceneNames)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.String>	sceneNames	Scenes to load by name.

SceneLoadData(List<Scene>)

Declaration

public SceneLoadData(List<Scene> scenes)

Parameters

Type	Name	Description
System.Collections.Generic.List<UnityEngine.SceneManagement.Scene>	scenes	Scenes to load.

SceneLoadData(Int32)

Declaration

public SceneLoadData(int sceneHandle)

Parameters

Type	Name	Description
System.Int32	sceneHandle	Scene to load by handle.

SceneLoadData(Int32, String)

Declaration

public SceneLoadData(int sceneHandle, string sceneName)

Parameters

Type	Name	Description
System.Int32	sceneHandle	Scene to load by handle.
System.String	sceneName	Scene to load by name.

SceneLoadData(Int32[])

Declaration

public SceneLoadData(int[] sceneHandles)

Parameters

Type	Name	Description
System.Int32[]	sceneHandles	Scenes to load by handle.

SceneLoadData(Int32[], NetworkObject[])

Declaration

public SceneLoadData(int[] sceneHandles, NetworkObject[] movedNetworkObjects)

Parameters

Type	Name	Description
System.Int32[]	sceneHandles	Scenes to load by handle.
NetworkObject[]	movedNetworkObjects	NetworkObjects to move to the first specified scene.

SceneLoadData(String)

Declaration

public SceneLoadData(string sceneName)

Parameters

Type	Name	Description
System.String	sceneName	Scene to load by name.

SceneLoadData(String[])

Declaration

public SceneLoadData(string[] sceneNames)

Parameters

Type	Name	Description
System.String[]	sceneNames	Scenes to load by name.

SceneLoadData(String[], NetworkObject[])

Declaration

public SceneLoadData(string[] sceneNames, NetworkObject[] movedNetworkObjects)

Parameters

Type	Name	Description
System.String[]	sceneNames	Scenes to load by Name.
NetworkObject[]	movedNetworkObjects	NetworkObjects to move to the first specified scene.

SceneLoadData(Scene)

Declaration

public SceneLoadData(Scene scene)

Parameters

Type	Name	Description
UnityEngine.SceneManagement.Scene	scene	Scene to load.

SceneLoadData(Scene, NetworkObject[])

Declaration

public SceneLoadData(Scene scene, NetworkObject[] movedNetworkObjects)

Parameters

Type	Name	Description
UnityEngine.SceneManagement.Scene	scene	Scene to load.
NetworkObject[]	movedNetworkObjects	NetworkObjects to move to the first specified scene.

SceneLoadData(Scene[])

Declaration

public SceneLoadData(Scene[] scenes)

Parameters

Type	Name	Description
UnityEngine.SceneManagement.Scene[]	scenes	Scenes to load.

SceneLoadData(Scene[], NetworkObject[])

Declaration

public SceneLoadData(Scene[] scenes, NetworkObject[] movedNetworkObjects)

Parameters

Type	Name	Description
UnityEngine.SceneManagement.Scene[]	scenes	Scenes to load.
NetworkObject[]	movedNetworkObjects	NetworkObjects to move to the first specified scene.

Fields

MovedNetworkObjects

NetworkObjects to move to the new scenes. Objects will be moved to the first scene.

Declaration

public NetworkObject[] MovedNetworkObjects

Field Value

Type	Description
NetworkObject[]

Options

Additional options to use for loaded scenes.

Declaration

public LoadOptions Options

Field Value

Type	Description
LoadOptions

Params

Parameters which may be set and will be included in load callbacks.

Declaration

public LoadParams Params

Field Value

Type	Description
LoadParams

PreferredActiveScene

When specified these scenes will be set as the active scene after loading occurs.

Declaration

public PreferredScene PreferredActiveScene

Field Value

Type	Description
PreferredScene

ReplaceScenes

How to replace current scenes with new ones. When replacing scenes the first scene loaded will be set as the active scene, and the rest additive.

Declaration

public ReplaceOption ReplaceScenes

Field Value

Type	Description
ReplaceOption

SceneLookupDatas

SceneLookupData for each scene to load.

Declaration

public SceneLookupData[] SceneLookupDatas

Field Value

Type	Description
SceneLookupData[]

Methods

GetFirstLookupScene()

Gets the first Scene in SceneLookupDatas.

Declaration

public Scene GetFirstLookupScene()

Returns

Type	Description
UnityEngine.SceneManagement.Scene