Struct Id

Namespace

Xabbo

Assembly

Xabbo.Common.dll

Represents a numeric identifier.

public readonly record struct Id : IComparable<Id>, IComparable, IEquatable<Id>

Implements

IComparable<Id>

IComparable

IEquatable<Id>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

Remarks

This type is represented as the following:

• On Unity as a long.
• On Flash as an int.
• On Shockwave as a VL64.

Fields

MaxValue

The maximum value of an Id.

public const long MaxValue = 9223372036854775807

Field Value

long

MinValue

The minimum value of and Id.

public const long MinValue = -9223372036854775808

Field Value

long

Methods

CompareTo(object?)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

public int CompareTo(object? obj)

Parameters

obj object

An object to compare with this instance.

Returns

int

A value that indicates the relative order of the objects being compared. The return value has these meanings:

Value	Meaning
Less than zero	This instance precedes obj in the sort order.
Zero	This instance occurs in the same position in the sort order as obj.
Greater than zero	This instance follows obj in the sort order.

Exceptions

ArgumentException

obj is not the same type as this instance.

CompareTo(Id)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

public int CompareTo(Id other)

Parameters

other Id

An object to compare with this instance.

Returns

int

A value that indicates the relative order of the objects being compared. The return value has these meanings:

Value	Meaning
Less than zero	This instance precedes other in the sort order.
Zero	This instance occurs in the same position in the sort order as other.
Greater than zero	This instance follows other in the sort order.

ToString()

Returns the value of this Id as a string.

public override string ToString()

Returns

string

TryParse(string?, out Id)

Parses a string representation of an Id to its value and returns whether the conversion was successful.

public static bool TryParse(string? s, out Id id)

Parameters

s string

The string to parse.

id Id

The parsed Id.

Returns

bool

Operators

explicit operator Id(string)

public static explicit operator Id(string s)

Parameters

s string

Returns

Id

implicit operator Id(long)

public static implicit operator Id(long value)

Parameters

value long

Returns

Id

implicit operator long(Id)

public static implicit operator long(Id id)

Parameters

id Id

Returns

long