Struct TimeEffectHandle

Handle returned by TimeEffects helpers. Wraps the underlying TimeScaleModifierHandle plus a reference to the clock that owns the effect, so a single Cancel() call removes the modifier without forcing the caller to remember which clock it came from.

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Scylla.Core.Time

Assembly: ScyllaCore.dll

Syntax

public readonly struct TimeEffectHandle

Constructors

TimeEffectHandle(ScyllaClock, TimeScaleModifierHandle)

Initializes a handle pairing a clock with the modifierHandle returned when the effect modifier was pushed. Callers should not construct this directly; use the factory methods on TimeEffects instead.

Declaration

public TimeEffectHandle(ScyllaClock clock, TimeScaleModifierHandle modifierHandle)

Parameters

Type	Name	Description
ScyllaClock	clock
TimeScaleModifierHandle	modifierHandle

Properties

Clock

The clock that hosts the effect's modifier.

Declaration

public ScyllaClock Clock { get; }

Property Value

Type	Description
ScyllaClock

IsValid

True if both Clock and ModifierHandle are set.

Declaration

public bool IsValid { get; }

Property Value

Type	Description
bool

ModifierHandle

The underlying modifier handle on the clock's modifier stack.

Declaration

public TimeScaleModifierHandle ModifierHandle { get; }

Property Value

Type	Description
TimeScaleModifierHandle

Methods

Cancel()

Cancels the effect early, removing its modifier from the clock's stack. Returns true if the modifier was found and removed; false if it was already removed (auto-expired) or the handle is invalid.

Declaration

public bool Cancel()

Returns

Type	Description
bool