SceneService Class

Global service for scene management

Inheritance Hierarchy

Namespace: ImmerseSDK
Assembly: ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.7.0.0 (3.7.0.0)

Syntax

public sealed class SceneService : SingletonBehaviour

The SceneService type exposes the following members.

Constructors

	Name	Description
	SceneService
	SceneService	Initializes a new instance of the SceneService class

Properties

	Name	Description
	Bounds	Scene bounds
	CurrentScene	Current scene build index
	IsSceneRestarting	True if the scene is restarting
	Loading	True if a scene is still loading, otherwise false
	Progress	Amount of progress for the scene load

Methods

	Name	Description
	CoroutineInitialise	This method is used by our internal systems so do not call it directly. (Overrides SingletonBehaviourCoroutineInitialise.)
	FindAllT	Finds all the components in all the currently loaded scenes
	GetDontDestroyOnLoadRootGameObjects	Get all objects in the DontDestroyOnLoad scene
	LoadSceneAdditivelyCoroutine
	SendAcknowledgeResetScene	Sends the reset scene ACK message to all currently connected clients.
	SendDeleteMessageForAll(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
	SendDeleteMessageForAllT(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
	SendDeleteMessageForAllT(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
	ToString	Returns "Scene Service" (Overrides UnityEngine.Object.ToString.)

Fields

	Name	Description
	DefaultSceneName	Name of the default scene
	DefaultScenePath	Path to default scene
	TimeoutForResetSceneAcknowledgeWaitInSeconds	This is the maximum time (in seconds) we will wait for everybody else to reset and reload their scene

Extension Methods

	Name	Description
	GetCopyOf	Copies all properties of a component from source to target. Uses reflection to set properties. (Defined by ComponentExtensions.)
	WaitForT	Waits for a singleton on a coroutine (Defined by SingletonManager.)