Class SceneReference

References a scene in a way that is safe for serialization and build settings changes.

Inheritance

object

Object

ScriptableObject

SceneReference

Inherited Members

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Xareus.Scenarios.Unity

Assembly: Xareus.Unity.Libraries.dll

Syntax

[Serializable]
public class SceneReference : ScriptableObject

Properties

AllReferences

Declaration

protected static HashSet<SceneReference> AllReferences { get; }

Property Value

Type	Description
HashSet<SceneReference>

Asset

Declaration

public SceneAsset Asset { get; }

Property Value

Type	Description
SceneAsset

BuildIndex

Build index of the scene (-1 if not found in the Build Settings)

Declaration

public int BuildIndex { get; }

Property Value

Type	Description
int

IsValid

Checks if the scene is valid and in the Build Settings

Declaration

public bool IsValid { get; }

Property Value

Type	Description
bool

SceneName

SceneName without extension

Declaration

public string SceneName { get; }

Property Value

Type	Description
string

ScenePath

Declaration

public string ScenePath { get; }

Property Value

Type	Description
string

Methods

FromBuildIndex(int)

Declaration

public static SceneReference FromBuildIndex(int buildIndex)

Parameters

Type	Name	Description
int	buildIndex

Returns

Type	Description
SceneReference

FromSceneAsset(SceneAsset)

Declaration

public static SceneReference FromSceneAsset(SceneAsset asset)

Parameters

Type	Name	Description
SceneAsset	asset

Returns

Type	Description
SceneReference

FromSceneName(string)

Declaration

public static SceneReference FromSceneName(string sceneName)

Parameters

Type	Name	Description
string	sceneName

Returns

Type	Description
SceneReference

OnAfterDeserialize()

Declaration

public void OnAfterDeserialize()

OnBeforeSerialize()

Declaration

public void OnBeforeSerialize()

ToString()

Returns the name of the object.

Declaration

public override string ToString()

Returns

Type	Description
string	The name returned by ToString.

Overrides

UnityEngine.Object.ToString()

TryGetSceneReference(int, out SceneReference)

Declaration

public static bool TryGetSceneReference(int buildIndex, out SceneReference sceneReference)

Parameters

Type	Name	Description
int	buildIndex
SceneReference	sceneReference

Returns

Type	Description
bool

TryGetSceneReference(string, out SceneReference)

Declaration

public static bool TryGetSceneReference(string sceneName, out SceneReference sceneReference)

Parameters

Type	Name	Description
string	sceneName
SceneReference	sceneReference

Returns

Type	Description
bool