Class SceneReference

Represents the reference to the scene asset. Stores the unique ID of the scene to reference. Can be used to load the selected scene.

System.Object
SceneReference
System.IComparable
System.IComparable<System.Guid>
System.IComparable<SceneReference>
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[Unmanaged]
public sealed class SceneReference : ValueType, IComparable, IComparable<Guid>, IComparable<SceneReference>

Constructors

SceneReference(Guid)

Initializes a new instance of the SceneReference class.

Declaration
public SceneReference(Guid id)
Parameters
System.Guid id

The identifier of the scene asset.

Fields

ID

The identifier of the scene asset (and the scene object).

Declaration
public Guid ID
Field Value
System.Guid

Methods

CompareTo(SceneReference)

Declaration
public int CompareTo(SceneReference other)
Parameters
SceneReference other

Returns
System.Int32

CompareTo(Guid)

Declaration
public int CompareTo(Guid other)
Parameters
System.Guid other

Returns
System.Int32

CompareTo(Object)

Declaration
public int CompareTo(object obj)
Parameters
System.Object obj

Returns
System.Int32

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

Returns
System.Boolean

GetHashCode()

Declaration
public override int GetHashCode()
Returns
System.Int32

ToString()

Declaration
public override string ToString()
Returns
System.String

Operators

Equality(SceneReference, SceneReference)

Compares two values and returns true if are equal or false if unequal.

Declaration
public static bool operator ==(SceneReference left, SceneReference right)
Parameters
SceneReference left

The left value.
SceneReference right

The right value.
Returns
System.Boolean

True if values are equal, otherwise false.

Equality(SceneReference, Guid)

Compares two values and returns true if are equal or false if unequal.

Declaration
public static bool operator ==(SceneReference left, Guid right)
Parameters
SceneReference left

The left value.
System.Guid right

The right value.
Returns
System.Boolean

True if values are equal, otherwise false.

Inequality(SceneReference, SceneReference)

Compares two values and returns false if are equal or true if unequal.

Declaration
public static bool operator !=(SceneReference left, SceneReference right)
Parameters
SceneReference left

The left value.
SceneReference right

The right value.
Returns
System.Boolean

True if values are not equal, otherwise false.

Inequality(SceneReference, Guid)

Compares two values and returns false if are equal or true if unequal.

Declaration
public static bool operator !=(SceneReference left, Guid right)
Parameters
SceneReference left

The left value.
System.Guid right

The right value.
Returns
System.Boolean

True if values are not equal, otherwise false.

Extension Methods