Struct SpatialRegionHandle

Namespace

Typhon.Engine

Assembly

Typhon.Engine.dll

Opaque handle to a registered trigger region. Validated via generation counter to detect use-after-destroy.

public readonly struct SpatialRegionHandle : IEquatable<SpatialRegionHandle>

Implements

IEquatable<SpatialRegionHandle>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Methods

Equals(object)

Indicates whether obj is a SpatialRegionHandle equal to this one.

public override bool Equals(object obj)

Parameters

obj object

Object to compare against.

Returns

bool

true if obj is an equal handle.

Equals(SpatialRegionHandle)

Indicates whether this handle equals other (same slot index and generation).

public bool Equals(SpatialRegionHandle other)

Parameters

other SpatialRegionHandle

Handle to compare against.

Returns

bool

true if both refer to the same region registration.

GetHashCode()

Returns a hash code combining the slot index and generation.

public override int GetHashCode()

Returns

int

ToString()

Returns a string of the form Region(index:generation).

public override string ToString()

Returns

string

Operators

operator ==(SpatialRegionHandle, SpatialRegionHandle)

Equality operator; see Equals(SpatialRegionHandle).

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

Parameters

left SpatialRegionHandle

Left handle.

right SpatialRegionHandle

Right handle.

Returns

bool

true if the handles are equal.

operator !=(SpatialRegionHandle, SpatialRegionHandle)

Inequality operator; see Equals(SpatialRegionHandle).

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

Parameters

left SpatialRegionHandle

Left handle.

right SpatialRegionHandle

Right handle.

Returns

bool

true if the handles differ.