Click or drag to resize

SceneService Class

Global service for scene management
Inheritance Hierarchy

Namespace:  ImmerseSDK
Assembly:  ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.5.0.0 (3.5.0.0)
Syntax
C#
public sealed class SceneService : SingletonBehaviour

The SceneService type exposes the following members.

Constructors
  NameDescription
Private methodStatic memberSceneService
Public methodSceneService
Initializes a new instance of the SceneService class
Top
Properties
  NameDescription
Public propertyBounds
Scene bounds
Public propertyCurrentScene
Current scene build index
Public propertyIsSceneRestarting
True if the scene is restarting
Public propertyLoading
True if a scene is still loading, otherwise false
Public propertyProgress
Amount of progress for the scene load
Top
Methods
  NameDescription
Public methodCoroutineInitialise
This method is used by our internal systems so do not call it directly.
(Overrides SingletonBehaviourCoroutineInitialise.)
Public methodStatic memberFindAllT
Finds all the components in all the currently loaded scenes
Public methodStatic memberGetDontDestroyOnLoadRootGameObjects
Get all objects in the DontDestroyOnLoad scene
Public methodLoadSceneAdditivelyCoroutine
Public methodSendAcknowledgeResetScene
Sends the reset scene ACK message to all currently connected clients.
Public methodSendDeleteMessageForAll(MessageTypes, ListMessageID)
Delete all persisted state for the specified messageIDs in the current scene Note: Our message queue will automagically pack messages up in batches to optimize network traffic
Public methodSendDeleteMessageForAllT(UInt16)
Delete all persisted state for the specified class in the current scene Note: Our message queue will automagically pack messages up in batches to optimize network traffic
Public methodSendDeleteMessageForAllT(UInt16, ListT)
Delete all persisted state for the specified class in the current scene Note: Our message queue will automagically pack messages up in batches to optimize network traffic
Public methodToString
Returns "Scene Service"
(Overrides UnityEngine.Object.ToString.)
Top
Fields
  NameDescription
Public fieldStatic memberDefaultSceneName
Name of the default scene
Public fieldStatic memberDefaultScenePath
Path to default scene
Public fieldStatic memberTimeoutForResetSceneAcknowledgeWaitInSeconds
This is the maximum time (in seconds) we will wait for everybody else to reset and reload their scene
Top
Extension Methods
  NameDescription
Public Extension MethodGetCopyOf
Copies all properties of a component from source to target. Uses reflection to set properties.
(Defined by ComponentExtensions.)
Public Extension MethodWaitForT
Waits for a singleton on a coroutine
(Defined by SingletonManager.)
Top
See Also