Struct ClockDebugInfo

Read-only snapshot of one clock's runtime state for debug overlays and inspectors. Allocation-free to construct; safe to display every frame from a debug HUD.

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 ClockDebugInfo

Constructors

ClockDebugInfo(string, string, bool, bool, bool, long, float, float, float, int, int, GameDate)

Initializes a new debug snapshot with the supplied per-clock runtime values. All parameters correspond directly to the same-named properties on ScyllaClock.

Declaration

public ClockDebugInfo(string clockID, string displayName, bool isMaster, bool isPaused, bool isReversed, long currentTickMs, float baseTickRate, float speedMultiplier, float effectiveRate, int modifierCount, int scheduledCount, GameDate currentDate)

Parameters

Type	Name	Description
string	clockID
string	displayName
bool	isMaster
bool	isPaused
bool	isReversed
long	currentTickMs
float	baseTickRate
float	speedMultiplier
float	effectiveRate
int	modifierCount
int	scheduledCount
GameDate	currentDate

Fields

BaseTickRate

The base tick rate from the clock definition.

Declaration

public readonly float BaseTickRate

Field Value

Type	Description
float

ClockID

The clock's identifier.

Declaration

public readonly string ClockID

Field Value

Type	Description
string

CurrentDate

Resolved current date (or default(GameDate) when no calendar is assigned).

Declaration

public readonly GameDate CurrentDate

Field Value

Type	Description
GameDate

CurrentTickMilliseconds

The clock's current millisecond tick value.

Declaration

public readonly long CurrentTickMilliseconds

Field Value

Type	Description
long

DisplayName

Human-readable label.

Declaration

public readonly string DisplayName

Field Value

Type	Description
string

EffectiveRate

The post-modifier-stack effective in-game-seconds-per-real-second rate.

Declaration

public readonly float EffectiveRate

Field Value

Type	Description
float

IsMaster

Whether the clock is the project's master.

Declaration

public readonly bool IsMaster

Field Value

Type	Description
bool

IsPaused

Whether the clock is currently paused (own pause OR global pause respected).

Declaration

public readonly bool IsPaused

Field Value

Type	Description
bool

IsReversed

True when the clock is currently running with a negative effective rate.

Declaration

public readonly bool IsReversed

Field Value

Type	Description
bool

ModifierCount

Number of active modifiers on the clock's stack.

Declaration

public readonly int ModifierCount

Field Value

Type	Description
int

ScheduledCount

Number of scheduled entries waiting to fire on this clock.

Declaration

public readonly int ScheduledCount

Field Value

Type	Description
int

SpeedMultiplier

The current speed multiplier on top of the base rate.

Declaration

public readonly float SpeedMultiplier

Field Value

Type	Description
float