Quantum 3 3.0.3

Classes | Static Public Member Functions | List of all members
Quantum.QuantumUnitySceneManagerUtils Class Reference

Exension and utility methods for SceneManager and Scene types. More...

Classes

class  SceneEqualityComparer
 A comparer that can be used when scenes need to be comparable, like when being as keys in a dictionary. More...
 

Static Public Member Functions

static bool CanBeUnloaded (this Scene scene)
 Returns true if scene can be unloaded. More...
 
static string Dump (this LoadSceneParameters loadSceneParameters)
 Converts loadSceneParameters to string. More...
 
static string Dump (this Scene scene)
 Converts scene into string, dumping all its fields and properties. More...
 
static int GetSceneBuildIndex (string nameOrPath)
 Gets scene's build index based on its name or path. More...
 
static bool IsAddedToBuildSettings (this Scene scene)
 Returns true if scene is in the build settings. Note that just checking Scene.buildIndex is not enough. More...
 

Detailed Description

Exension and utility methods for SceneManager and Scene types.

Member Function Documentation

◆ IsAddedToBuildSettings()

static bool Quantum.QuantumUnitySceneManagerUtils.IsAddedToBuildSettings ( this Scene  scene)
inlinestatic

Returns true if scene is in the build settings. Note that just checking Scene.buildIndex is not enough.

◆ CanBeUnloaded()

static bool Quantum.QuantumUnitySceneManagerUtils.CanBeUnloaded ( this Scene  scene)
inlinestatic

Returns true if scene can be unloaded.

Parameters
scene
Returns

◆ Dump() [1/2]

static string Quantum.QuantumUnitySceneManagerUtils.Dump ( this Scene  scene)
inlinestatic

Converts scene into string, dumping all its fields and properties.

◆ Dump() [2/2]

static string Quantum.QuantumUnitySceneManagerUtils.Dump ( this LoadSceneParameters  loadSceneParameters)
inlinestatic

Converts loadSceneParameters to string.

◆ GetSceneBuildIndex()

static int Quantum.QuantumUnitySceneManagerUtils.GetSceneBuildIndex ( string  nameOrPath)
inlinestatic

Gets scene's build index based on its name or path.