Class SceneUnloadData
Data about which scenes to unload.
Inheritance
System.Object
SceneUnloadData
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 SceneUnloadData
Constructors
SceneUnloadData()
Declaration
public SceneUnloadData()
SceneUnloadData(SceneLookupData)
Declaration
public SceneUnloadData(SceneLookupData sceneLookupData)
Parameters
Type | Name | Description |
---|---|---|
SceneLookupData | sceneLookupData | Scene to unload by SceneLookupData. |
SceneUnloadData(SceneLookupData[])
Declaration
public SceneUnloadData(SceneLookupData[] sceneLookupDatas)
Parameters
Type | Name | Description |
---|---|---|
SceneLookupData[] | sceneLookupDatas | Scenes to unload by SceneLookupDatas. |
SceneUnloadData(List<Int32>)
Declaration
public SceneUnloadData(List<int> sceneHandles)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<System.Int32> | sceneHandles | Scenes to unload by handles. |
SceneUnloadData(List<String>)
Declaration
public SceneUnloadData(List<string> sceneNames)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<System.String> | sceneNames | Scenes to unload by names. |
SceneUnloadData(List<Scene>)
Declaration
public SceneUnloadData(List<Scene> scenes)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<UnityEngine.SceneManagement.Scene> | scenes | Scenes to unload. |
SceneUnloadData(Int32)
Declaration
public SceneUnloadData(int sceneHandle)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | sceneHandle | Scene to unload by handle. |
SceneUnloadData(Int32[])
Declaration
public SceneUnloadData(int[] sceneHandles)
Parameters
Type | Name | Description |
---|---|---|
System.Int32[] | sceneHandles | Scenes to unload by handles. |
SceneUnloadData(String)
Declaration
public SceneUnloadData(string sceneName)
Parameters
Type | Name | Description |
---|---|---|
System.String | sceneName | Scene to unload by name. |
SceneUnloadData(String[])
Declaration
public SceneUnloadData(string[] sceneNames)
Parameters
Type | Name | Description |
---|---|---|
System.String[] | sceneNames | Scenes to unload by names. |
SceneUnloadData(Scene)
Declaration
public SceneUnloadData(Scene scene)
Parameters
Type | Name | Description |
---|---|---|
UnityEngine.SceneManagement.Scene | scene | Scene to unload. |
SceneUnloadData(Scene[])
Declaration
public SceneUnloadData(Scene[] scenes)
Parameters
Type | Name | Description |
---|---|---|
UnityEngine.SceneManagement.Scene[] | scenes | Scenes to unload. |
Fields
Options
Additional options to use for loaded scenes.
Declaration
public UnloadOptions Options
Field Value
Type | Description |
---|---|
UnloadOptions |
Params
Parameters which may be set and will be included in load callbacks.
Declaration
public UnloadParams Params
Field Value
Type | Description |
---|---|
UnloadParams |
PreferredActiveScene
When specified these scenes will be set as the active scene after loading occurs.
Declaration
public PreferredScene PreferredActiveScene
Field Value
Type | Description |
---|---|
PreferredScene |
SceneLookupDatas
SceneLookupData for each scene to load.
Declaration
public SceneLookupData[] SceneLookupDatas
Field Value
Type | Description |
---|---|
SceneLookupData[] |