Class SceneProcessorBase
Inheritance
Inherited Members
Namespace: FishNet.Managing.Scened
Assembly: FishNet.Runtime.dll
Syntax
public abstract class SceneProcessorBase : MonoBehaviour
Fields
DelayedDestroyScene
Scene used to store objects queued for destruction but cannot be destroyed until the clientHost gets the despawn packet.
Declaration
protected Scene DelayedDestroyScene
Field Value
Type | Description |
---|---|
UnityEngine.SceneManagement.Scene |
FallbackActiveScene
Scene used as the active scene when the user does not specify which scene to set active and the scenemanager cannot determine one without error. This is primarily used so scenes with incorrect or unexpected lighting are not set as the active scene given this may disrupt visuals.
Declaration
protected Scene FallbackActiveScene
Field Value
Type | Description |
---|---|
UnityEngine.SceneManagement.Scene |
MovedObjectsScene
Scene used to store objects while they are being moved from one scene to another.
Declaration
protected Scene MovedObjectsScene
Field Value
Type | Description |
---|---|
UnityEngine.SceneManagement.Scene |
SceneManager
SceneManager for this processor.
Declaration
protected SceneManager SceneManager
Field Value
Type | Description |
---|---|
SceneManager |
Methods
ActivateLoadedScenes()
Activates scenes which were loaded.
Declaration
public abstract void ActivateLoadedScenes()
AddLoadedScene(Scene)
Adds a scene to loaded scenes.
Declaration
public virtual void AddLoadedScene(Scene scene)
Parameters
Type | Name | Description |
---|---|---|
UnityEngine.SceneManagement.Scene | scene | Scene loaded. |
AsyncsIsDone()
Returns if all asynchronized tasks are considered IsDone.
Declaration
public abstract IEnumerator AsyncsIsDone()
Returns
Type | Description |
---|---|
System.Collections.IEnumerator |
BeginLoadAsync(String, LoadSceneParameters)
Begin loading a scene using an async method.
Declaration
public abstract void BeginLoadAsync(string sceneName, LoadSceneParameters parameters)
Parameters
Type | Name | Description |
---|---|---|
System.String | sceneName | Scene name to load. |
UnityEngine.SceneManagement.LoadSceneParameters | parameters |
BeginUnloadAsync(Scene)
Begin unloading a scene using an async method.
Declaration
public abstract void BeginUnloadAsync(Scene scene)
Parameters
Type | Name | Description |
---|---|---|
UnityEngine.SceneManagement.Scene | scene |
FindOrCreateScene(String)
Tries to find a scene by name and if it does not exist creates an empty scene of name.
Declaration
public virtual Scene FindOrCreateScene(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Name of the scene to find or create. |
Returns
Type | Description |
---|---|
UnityEngine.SceneManagement.Scene |
GetDelayedDestroyScene()
Returns the DelayedDestroyScene.
Declaration
public virtual Scene GetDelayedDestroyScene()
Returns
Type | Description |
---|---|
UnityEngine.SceneManagement.Scene |
GetFallbackActiveScene()
Returns the FallbackActiveScene.
Declaration
public virtual Scene GetFallbackActiveScene()
Returns
Type | Description |
---|---|
UnityEngine.SceneManagement.Scene |
GetLoadedScenes()
Returns scenes which were loaded during a load operation.
Declaration
public abstract List<Scene> GetLoadedScenes()
Returns
Type | Description |
---|---|
System.Collections.Generic.List<UnityEngine.SceneManagement.Scene> |
GetMovedObjectsScene()
Returns the MovedObjectsScene.
Declaration
public virtual Scene GetMovedObjectsScene()
Returns
Type | Description |
---|---|
UnityEngine.SceneManagement.Scene |
GetPercentComplete()
Returns the progress on the current scene load or unload.
Declaration
public abstract float GetPercentComplete()
Returns
Type | Description |
---|---|
System.Single |
Initialize(SceneManager)
Initializes this script for use.
Declaration
public virtual void Initialize(SceneManager manager)
Parameters
Type | Name | Description |
---|---|---|
SceneManager | manager | SceneManager which will be utilizing this class. |
IsPercentComplete()
Returns if a scene load or unload percent is done.
Declaration
public abstract bool IsPercentComplete()
Returns
Type | Description |
---|---|
System.Boolean |
LoadEnd(LoadQueueData)
Called when scene loading has ended.
Declaration
public virtual void LoadEnd(LoadQueueData queueData)
Parameters
Type | Name | Description |
---|---|---|
LoadQueueData | queueData |
LoadStart(LoadQueueData)
Called when scene loading has begun.
Declaration
public virtual void LoadStart(LoadQueueData queueData)
Parameters
Type | Name | Description |
---|---|---|
LoadQueueData | queueData |
UnloadEnd(LoadQueueData)
Called when scene unloading has ended within a load operation.
Declaration
public virtual void UnloadEnd(LoadQueueData queueData)
Parameters
Type | Name | Description |
---|---|---|
LoadQueueData | queueData |
UnloadEnd(UnloadQueueData)
Called when scene unloading has ended within an unload operation.
Declaration
public virtual void UnloadEnd(UnloadQueueData queueData)
Parameters
Type | Name | Description |
---|---|---|
UnloadQueueData | queueData |
UnloadStart(LoadQueueData)
Called when scene unloading has begun within a load operation.
Declaration
public virtual void UnloadStart(LoadQueueData queueData)
Parameters
Type | Name | Description |
---|---|---|
LoadQueueData | queueData |
UnloadStart(UnloadQueueData)
Called when scene unloading has begun within an unload operation.
Declaration
public virtual void UnloadStart(UnloadQueueData queueData)
Parameters
Type | Name | Description |
---|---|---|
UnloadQueueData | queueData |