Struct SceneId

This struct holds information about scene identifier.

Inherited Members
Namespace: Unity.Cloud.Common
Syntax
public readonly struct SceneId

Constructors

SceneId(Guid)

Returns a SceneId using a Guid.

Declaration
public SceneId(Guid value)
Parameters
Type Name Description
Guid value

The guid representing the scene identifier

SceneId(String)

Returns a SceneId using a String.

Declaration
public SceneId(string value)
Parameters
Type Name Description
String value

The string representing the scene identifier

Fields

None

Return the value of an identifier representing an invalid scene id

Declaration
public static readonly SceneId None
Field Value
Type Description
SceneId

Methods

Equals(Object)

Validate obj is a SceneId instance and have the same values as this instance.

Declaration
public override readonly bool Equals(object obj)
Parameters
Type Name Description
Object obj

Compare the values with this instance.
Returns
Type Description
Boolean

true if both instance have the same values; false otherwise.
Overrides

Equals(SceneId)

Returns whether two SceneId objects are equals.

Declaration
public readonly bool Equals(SceneId other)
Parameters
Type Name Description
SceneId other
Returns
Type Description
Boolean

true if both instance have the same values; false otherwise.

GetHashCode()

Compute a hash code for the object.

Declaration
public override readonly int GetHashCode()
Returns
Type Description
Int32

A hash code for the current object.
Overrides
Remarks
  • You should not assume that equal hash codes imply object equality.
  • You should never persist or use a hash code outside the application domain in which it was created, because the same object may hash differently across application domains, processes, and platforms.

ToString()

Get the string representation of this SceneId.

Declaration
public override readonly string ToString()
Returns
Type Description
String

The string result.
Overrides

Operators

Equality(SceneId, SceneId)

Get if two SceneId represent the same.

Declaration
public static bool operator ==(SceneId left, SceneId right)
Parameters
Type Name Description
SceneId left

Compare with this first instance.
SceneId right

Compare with this other instance.
Returns
Type Description
Boolean

true if both instances represent the same; false otherwise.

Explicit(SceneId to String)

Declaration
public static explicit operator string (SceneId sId)
Parameters
Type Name Description
SceneId sId
Returns
Type Description
String

Inequality(SceneId, SceneId)

Get if two SceneId does not represent the same.

Declaration
public static bool operator !=(SceneId left, SceneId right)
Parameters
Type Name Description
SceneId left

Compare with this first instance.
SceneId right

Compare with this other instance.
Returns
Type Description
Boolean

true if both instances are not the same; false if both instances are the same.