FB2CalendarManager

Overview

Manages the calendar and world-event schedule.

Metadata

Field	Value
Kind	`system`
Environment	B2 - Simulation
Category	`systems`
Extends	`FB2ManagerBase`
Require	`require('Systems.B2CalendarManager')`

Properties (6)

Name	Type	Description
`ActiveRegionalFestivals`	`table<string, FB1ActiveWorldCalendarEvent>`
`ActiveWorldEvent`	`FB1ActiveWorldCalendarEvent`
`CalendarDayInfos`	`FB1CalendarDayInfo[]`
`LastCalendarSeason`	`EB1SeasonType`	The season at the last calendar reset (used to detect season changes).
`LastPredayNotificationDate`	`integer`	In-game date used to prevent duplicate holiday notifications.
`LastTodayNotificationDate`	`integer`

Functions (21)

Function	Parameters	Returns	Description
`Cheat_EndCalendarEvent`	`-`	`-`
`Cheat_StartCalendarEvent`	InCalendarEvent: `string`	`-`
`EndRegionalFestival`	InCalendarEventId: `string`	`-`	Ends Regional Festival.
`EndWorldCalendarEvent`	`-`	`-`	Ends World Calendar Event.
`GetActiveEventRuleTags`	`-`	`string[]`	Returns Active Event Rule Tags.
`GetActiveWorldCalendarEventId`	`-`	`string`	Returns Active World Calendar Event Id.
`GetActiveWorldCalendarEventObjectThemeId`	`-`	`string`	Returns Active World Calendar Event Object Theme Id.
`GetDaysUntilBirthdayByBioComponent` (static)	InBioComponent: `FB2BioComponent`, InOutDaysUntilBirthday: `integer`	`boolean`	Returns Days Until Birthday By Bio Component.
`GetDaysUntilBirthdayByEntityId` (static)	InEntityId: `FB1EntityId`, InOutDaysUntilBirthday: `integer`	`boolean`	Computes the number of days until the character's next birthday.
`IsCalendarEventActive`	InCalendarEventId: `string`	`boolean`	Returns whether Calendar Event Active.
`IsHolidayForDayOfWeek`	InDayOfWeek: `EB1DayOfWeek`	`boolean`	Checks via CalendarDayInfos whether the next occurrence of the given weekday is a holiday. Used when generating timelines.
`IsHolidayToday`	`-`	`boolean`	Returns whether today is a holiday, based on ActiveWorldEvent or CalendarDayInfos.
`IsWorldCalendarEventActive`	InType: `EB1CalendarEventType`	`boolean`	Returns whether World Calendar Event Active.
`OnChangePossessHouseholdEntityId`	InPrevHouseholdEntityId: `FB1EntityId`, InCurrHouseholdEntityId: `FB1EntityId`	`-`	Callback invoked on Change Possess Household Entity Id.
`OnDayChanged`	InPrevTime: `FDateTime`, InCurrentTime: `FDateTime`	`-`	Callback invoked on Day Changed.
`OnMinuteChanged`	InPrevTime: `FDateTime`, InCurrentTime: `FDateTime`	`-`	Callback invoked on Minute Changed.
`RefreshCalendarForSeasonChange`	`-`	`-`
`RefreshHouseholdCalendarEvents`	`-`	`-`
`StartRegionalFestival`	InCalendarEventId: `string`	`-`	Starts Regional Festival.
`StartWorldCalendarEvent`	InCalendarEventId: `string`	`-`	Starts World Calendar Event.
`TryGetDaysUntilCalendarEvent`	InCalendarEventId: `string`, OutDaysUntil: `integer`	`boolean`

Override points (11)

Implement these in Lua as FB2CalendarManager.Override_Name = function(...) end.

Function	Parameters	Returns	Description
`Override_Cheat_EndCalendarEvent`	`-`	`-`
`Override_Cheat_StartCalendarEvent`	InCalendarEvent: `string`	`-`
`Override_EndRegionalFestival`	InCalendarEventId: `string`	`-`	Ends Regional Festival.
`Override_EndWorldCalendarEvent`	`-`	`-`	Ends World Calendar Event.
`Override_OnChangePossessHouseholdEntityId`	InPrevHouseholdEntityId: `FB1EntityId`, InCurrHouseholdEntityId: `FB1EntityId`	`-`	Callback invoked on Change Possess Household Entity Id.
`Override_OnDayChanged`	InPrevTime: `FDateTime`, InCurrentTime: `FDateTime`	`-`	Callback invoked on Day Changed.
`Override_OnMinuteChanged`	InPrevTime: `FDateTime`, InCurrentTime: `FDateTime`	`-`	Callback invoked on Minute Changed.
`Override_RefreshCalendarForSeasonChange`	`-`	`-`
`Override_RefreshHouseholdCalendarEvents`	`-`	`-`
`Override_StartRegionalFestival`	InCalendarEventId: `string`	`-`	Starts Regional Festival.
`Override_StartWorldCalendarEvent`	InCalendarEventId: `string`	`-`	Starts World Calendar Event.