Struct ArbiterKey

Namespace

Jitter2.Dynamics

Assembly

Jitter2.dll

Represents an ordered pair of identifiers used to look up an Arbiter.

public readonly struct ArbiterKey : IEquatable<ArbiterKey>

Implements

IEquatable<ArbiterKey>

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Remarks

The order of key1 and key2 matters for equality comparison. For arbiters created by the physics engine, key1 is always less than key2.

Constructors

ArbiterKey(ulong, ulong)

Represents an ordered pair of identifiers used to look up an Arbiter.

public ArbiterKey(ulong key1, ulong key2)

Parameters

key1 ulong

The first identifier (typically the smaller shape ID).

key2 ulong

The second identifier (typically the larger shape ID).

Remarks

The order of key1 and key2 matters for equality comparison. For arbiters created by the physics engine, key1 is always less than key2.

Fields

Key1

The first identifier in the pair.

public readonly ulong Key1

Field Value

ulong

Key2

The second identifier in the pair.

public readonly ulong Key2

Field Value

ulong

Methods

Equals(ArbiterKey)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(ArbiterKey other)

Parameters

other ArbiterKey

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object?)

Indicates whether this instance and a specified object are equal.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

true if obj and this instance are the same type and represent the same value; otherwise, false.

GetHashCode()

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.

Operators

operator ==(ArbiterKey, ArbiterKey)

public static bool operator ==(ArbiterKey left, ArbiterKey right)

Parameters

left ArbiterKey

right ArbiterKey

Returns

bool

operator !=(ArbiterKey, ArbiterKey)

public static bool operator !=(ArbiterKey left, ArbiterKey right)

Parameters

left ArbiterKey

right ArbiterKey

Returns

bool