Skip to content

Class

CalendarTimeSemanticState

Generated GDScript class reference for CalendarTime.CalendarTimeSemanticState.

Status
Current
Version
v2.1.1
Source updated
2026-08-09
Generated on
2026-09-26

Compact, schema-versioned summary of a GameClock's authoritative time. Prefer stable domain values over arbitrary Node/property dumps. This state is derived only through the public GameClock / GameCalendar / DayNightCycleService API. It never reads or mutates implementation-private state. The same surface can back a future developer console, focused test fixtures, the godot-tools runtime adapter, and deterministic consumers. A [CalendarTimeSemanticState] is a pure read: it holds no clock lifetime and no signals. Consumers (console, runtime adapter, command layer) snapshot on demand via [method from_clock] and read the stable fields or [method to_dict].

Source: addons/calendar_time/semantic/calendar_time_semantic_state.gd

Syntax

class CalendarTimeSemanticState extends RefCounted

Members

NameKindSummary
SCHEMA_VERSIONField
calendar_identityPropertyCalendar identity — the authored calendar's config identity, falling back to its display name. Identifies WHICH time shape this snapshot uses.
clock_idPropertyThe clock's authored persistent id or its runtime id.
game_secondsProperty
microsecondsProperty
seconds_per_dayProperty
speed_multiplierPropertyRuntime pace: how fast this clock advances relative to host pacing.
pausedPropertyTrue when the clock is paused (speed_multiplier <= 0.0).
time_of_dayPropertyActive time-of-day stage display name when a DayNightCycleService is supplied and its calendar has TODs. Empty string when unavailable.
transitioningPropertyTrue when a time-of-day transition is in progress (0 < progress < 1).
transition_progressPropertyTransition progress fraction 0..1; -1.0 when not transitioning.
yearProperty
monthProperty
dayProperty
hourProperty
minuteProperty
secondProperty
from_clockMethod
to_dictMethod