Struct TimeScaleModifierHandle

An opaque handle returned by Push(TimeScaleModifier) that the caller uses to later cancel a specific modifier via Pop(TimeScaleModifierHandle).

Implements
Inherited Members
Namespace: Scylla.Core.Time
Assembly: ScyllaCore.dll
Syntax
public readonly struct TimeScaleModifierHandle : IEquatable<TimeScaleModifierHandle>
Remarks

Wraps an integer ID assigned by the stack. The default value (ID == 0) is invalid and represents "no handle". Comparison and hashing are based on ID alone, making the struct safe to store in collections.

Constructors

TimeScaleModifierHandle(int)

Wraps a stack-assigned ID into a handle.

Declaration
public TimeScaleModifierHandle(int id)
Parameters
Type Name Description
int id

Properties

ID

The integer identifier assigned by the originating TimeScaleModifierStack. 0 represents an invalid (default) handle.

Declaration
public int ID { get; }
Property Value
Type Description
int

IsValid

true when this handle holds a non-default ID.

Declaration
public bool IsValid { get; }
Property Value
Type Description
bool

Methods

Equals(TimeScaleModifierHandle)

Returns true when this handle's ID equals other's ID.

Declaration
public bool Equals(TimeScaleModifierHandle other)
Parameters
Type Name Description
TimeScaleModifierHandle other
Returns
Type Description
bool

Equals(object)

Returns true when obj is a TimeScaleModifierHandle with the same ID.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides

GetHashCode()

Returns the ID as the hash code. Consistent with Equals(TimeScaleModifierHandle).

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides

Operators

operator ==(TimeScaleModifierHandle, TimeScaleModifierHandle)

Returns true when both handles refer to the same modifier.

Declaration
public static bool operator ==(TimeScaleModifierHandle a, TimeScaleModifierHandle b)
Parameters
Type Name Description
TimeScaleModifierHandle a
TimeScaleModifierHandle b
Returns
Type Description
bool

operator !=(TimeScaleModifierHandle, TimeScaleModifierHandle)

Returns true when the handles refer to different modifiers.

Declaration
public static bool operator !=(TimeScaleModifierHandle a, TimeScaleModifierHandle b)
Parameters
Type Name Description
TimeScaleModifierHandle a
TimeScaleModifierHandle b
Returns
Type Description
bool

Implements