Skip to content

Class

GameCalendar

Generated GDScript class reference for CalendarTime.GameCalendar.

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

Calendar resource: unit conversions, date arithmetic, and year structure.

Source: addons/calendar_time/game_time/game_calendar/game_calendar.gd

Syntax

class GameCalendar extends Resource

Members

NameKindSummary
CalendarLogicField
CalendarStructureField
CalendarValidatorField
CalendarConfigurationField
display_namePropertyUI display name.
yearsPropertyYears the calendar represents, recycled in sequence after the last. At least one is required.
days_per_weekPropertyNumber of days in one week for this calendar.
start_day_of_week_indexPropertyThe array index that the first day of the week starts at
time_scalePropertyDefines the conversions between time units.
times_of_dayPropertyNamed phases of a day (dawn, day, dusk, night). Each `TimeOfDay` has an `HoursTime` enter-time; `DayNightCycleService` derives transitions from this list. Calendars own the schedule, so clocks sharing a calendar share phases.
start_datePropertyDate that the calendar treats as its epoch or first day.
structureProperty
safeProperty
safe_days_per_weekProperty
advance_date_timeMethod
get_game_yearMethod
get_event_dayMethod
get_game_monthMethod
get_day_of_week_indexMethod
get_days_per_weekMethod
get_days_betweenMethod
get_months_betweenMethod
get_days_into_yearMethod
get_next_dayMethod
get_next_date_timeMethod
get_previous_dateMethod
get_seconds_from_dateMethod
get_last_hours_time_as_secsMethod
get_last_hours_time_as_date_timeMethod
validate_runtimeMethod
get_scaleMethod
get_seconds_from_date_timeMethod
configuration_descriptorMethod
configuration_hashMethod
is_configuration_compatibleMethod
get_config_identityMethod