Class ClockTimeScaleChangedEvent

Fired when the clock's effective rate changes (speed multiplier edit or modifier stack change). Carries the previous and current rate for easy delta computation.

Inheritance
object
ScyllaEvent
ClockEvent
ClockTimeScaleChangedEvent
Inherited Members
Namespace: Scylla.Core.Time
Assembly: ScyllaCore.dll
Syntax
public sealed class ClockTimeScaleChangedEvent : ClockEvent

Constructors

ClockTimeScaleChangedEvent(string, GameDate, float, float)

Initializes a rate-changed event. IsReversing is derived from the sign of currentRate.

Declaration
public ClockTimeScaleChangedEvent(string clockID, GameDate snapshot, float previousRate, float currentRate)
Parameters
Type Name Description
string clockID
GameDate snapshot
float previousRate
float currentRate

Properties

CurrentRate

The effective rate (in-game seconds per real second) after the change.

Declaration
public float CurrentRate { get; }
Property Value
Type Description
float

Kind

Discriminator identifying which concrete subclass this event is.

Declaration
public override ClockEventKind Kind { get; }
Property Value
Type Description
ClockEventKind
Overrides

PreviousRate

The effective rate (in-game seconds per real second) before the change.

Declaration
public float PreviousRate { get; }
Property Value
Type Description
float

Extension Methods