FB2TimeManager

Overview

Simulation manager for in-game time: current time/day/date, time scale, and day/night state. (lua_manifest Manager binding key="Time")

Metadata

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

Properties (22)

Name	Type	Description
`AccRealTime`	`number`
`CachedRealTimeSecondsPerGameMinuteInDaytime`	`number`
`CachedTimeString`	`string`
`CurrentTimeScale`	`number`
`GameSpeedAccelerationHourEnd`	`integer`
`InitialTimeState`	`EB1TimeControlState`
`LastRabbitHoleEndedTicks`	`integer`	Game-time ticks at the moment the rabbit-hole ended.
`PauseReasons`	`table<EB1PauseReason, boolean>`
`RabbitholeSmoothTimeScaleBoundary`	`integer`
`RealTimeSecondToInGameMinuteRatio`	`number`	Ratio multiplied to reflect real time into time ticks. Default is real 1 second = game 1 minute (00:00-06:00); from 06:00-24:00 it slows to real 2 seconds = game 1 minute.
`RelativeTimeScaleByGame48Min`	`number`
`StartDay`	`integer`	refs...
`StartHour`	`integer`
`StartMinute`	`integer`
`TimeScaleFast`	`number`
`TimeScaleNormal`	`number`
`TimeScaleOverrides`	`table<EB1TimeScaleOverrideReason, number>`
`TimeScaleRabbitHole`	`number`
`TimeScaleRabbitHoleSmooth`	`number`
`TimeScaleVeryFast`	`number`
`bPossessHouseholdSleeping`	`boolean`
`bTriggerTimeScaleRabbitHole`	`boolean`

Functions (54)

Function	Parameters	Returns	Description
`AddTime`	InDay: `integer`, InHour: `integer`, InMinute: `integer`	`-`	Adds Time.
`BuildTimeString`	`-`	`-`
`CalcDateTimeAfterGameTime`	From: `FDateTime`, GameTimeMinute: `integer`	`FDateTime`
`ClearDelayedTask`	`-`	`-`	Clears Delayed Task.
`ClearPostProcessTask`	`-`	`-`	Clears Post Process Task.
`ConvertDayOfWeek`	InType: `EDayOfWeek`	`EB1DayOfWeek`
`CustomTickForLua`	State: `EB2SimulationState`, DeltaTime: `number`	`-`
`DelayedTasks`	`-`	`-`
`GetAccRealTime`	`-`	`number`	Returns Acc Real Time.
`GetCachedTimeString`	`-`	`string`	Returns Cached Time String.
`GetCurrentTicks`	`-`	`integer`	Returns Current Ticks.
`GetCurrentTime`	`-`	`FDateTime`	Returns Current Time.
`GetDay`	`-`	`integer`	Returns Day.
`GetDayOfWeek`	`-`	`EB1DayOfWeek`	Returns Day Of Week.
`GetHour`	`-`	`integer`	Returns Hour.
`GetLastRabbitHoleEndedTicks`	`-`	`integer`	Returns the game-time ticks when the rabbit-hole ended (used as a guard for character stat decay).
`GetMinute`	`-`	`integer`	Returns Minute.
`GetPlayTime`	`-`	`FDateTime`	Returns Play Time.
`GetPlayTimeSpan`	`-`	`FTimespan`	Returns Play Time Span.
`GetRealElapsedTime`	InElapsedTicks: `integer`	`number`	Returns Real Elapsed Time.
`GetRealTimeSecondToInGameMinuteRatio`	`-`	`number`	Returns Real Time Second To In Game Minute Ratio.
`GetRealTimeSecondsPerGameMinute`	`-`	`number`	Returns how many real-world seconds correspond to one in-game minute.
`GetRelativeTimeScale`	`-`	`number`	Returns the current time scale relative to the baseline of 1 in-game day = 48 real minutes.
`GetTimeForTimeline`	`-`	`integer`	Returns Time For Timeline.
`GetTimeScaleRawValue`	`-`	`number`	Returns Time Scale Raw Value.
`GetTimeScaleValue`	bIgnorePauseReason: `boolean`	`number`	Returns Time Scale Value.
`GetTimeState`	`-`	`EB1TimeControlState`	Returns Time State.
`IsAllHouseholdMemberSleeping`	InHouseholdId: `FB1EntityId`	`boolean`	Returns whether All Household Member Sleeping.
`IsContainsPauseReason`	InReason: `EB1PauseReason`	`boolean`	Returns whether Contains Pause Reason.
`IsNightTime`	InHour: `integer`	`boolean`	Returns whether Night Time.
`IsPaused`	`-`	`boolean`	Returns whether Paused.
`IsValidTimeScaleOverrideValue` (static)	Reason: `EB1TimeScaleOverrideReason`, TimeScale: `number`	`boolean`	Returns whether Valid Time Scale Override Value.
`IsValidTimeScaleRange` (static)	InTimeScale: `number`	`boolean`	Returns whether Valid Time Scale Range.
`OnChangePossessEntityId`	InPrevEntityId: `FB1EntityId`, InCurrEntityId: `FB1EntityId`	`-`	Callback invoked on Change Possess Entity Id.
`OnChangePossessHousehold`	InPrevHouseholdId: `FB1EntityId`, InCurrHouseholdId: `FB1EntityId`	`-`	Callback invoked on Change Possess Household.
`PostProcessTasks`	bSingleTask: `boolean`	`-`
`RemoveTimeScaleOverride`	InReason: `EB1TimeScaleOverrideReason`	`-`	Removes Time Scale Override.
`Reset`	`-`	`-`
`SendSyncTime`	`-`	`-`	Sends Sync Time.
`SetGamePaused`	InPause: `boolean`, InReason: `EB1PauseReason`	`-`	Sets Game Paused.
`SetRealTimeSecondsPerGameMinute`	InSeconds: `number`	`-`	Sets Real Time Seconds Per Game Minute.
`SetTimeScale`	InTimeScale: `number`	`-`	Sets Time Scale.
`SetTimeScaleOverride`	InReason: `EB1TimeScaleOverrideReason`, InTimeScale: `number`	`-`	Sets Time Scale Override.
`SetTimeState`	Type: `EB1TimeControlState`	`-`	Sets Time State.
`SetTriggerTimeScaleRabbitHole`	bInTriggerTimeScaleRabbitHole: `boolean`	`-`	Sets Trigger Time Scale Rabbit Hole.
`StaticGetAccRealTime` (static)	`-`	`number`
`StaticGetCurrentTicks` (static)	`-`	`integer`
`StaticGetCurrentTime` (static)	`-`	`FDateTime`
`StaticGetDayFromTicks` (static)	InTick: `integer`	`integer`
`StaticGetPassedDayCount` (static)	InFromTick: `integer`, InToTick: `integer`	`integer`
`StaticGetRealElapsedTime` (static)	InElapsedTicks: `integer`	`number`
`StaticIsPaused` (static)	`-`	`boolean`
`StaticIsTriggerTimeScaleRabbitHole` (static)	`-`	`boolean`
`TrySetPossessHouseholdSleeping`	bInValue: `boolean`	`-`

Override points (15)

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

Function	Parameters	Returns	Description
`Override_AddTime`	InDay: `integer`, InHour: `integer`, InMinute: `integer`	`-`	Adds Time.
`Override_BuildTimeString`	`-`	`-`
`Override_CalcDateTimeAfterGameTime`	From: `FDateTime`, GameTimeMinute: `integer`	`FDateTime`
`Override_ClearDelayedTask`	`-`	`-`	Clears Delayed Task.
`Override_ClearPostProcessTask`	`-`	`-`	Clears Post Process Task.
`Override_ConvertDayOfWeek`	InType: `EDayOfWeek`	`EB1DayOfWeek`
`Override_CustomTickForLua`	State: `EB2SimulationState`, DeltaTime: `number`	`-`
`Override_DelayedTasks`	`-`	`-`
`Override_OnChangePossessEntityId`	InPrevEntityId: `FB1EntityId`, InCurrEntityId: `FB1EntityId`	`-`	Callback invoked on Change Possess Entity Id.
`Override_OnChangePossessHousehold`	InPrevHouseholdId: `FB1EntityId`, InCurrHouseholdId: `FB1EntityId`	`-`	Callback invoked on Change Possess Household.
`Override_PostProcessTasks`	bSingleTask: `boolean`	`-`
`Override_RemoveTimeScaleOverride`	InReason: `EB1TimeScaleOverrideReason`	`-`	Removes Time Scale Override.
`Override_Reset`	`-`	`-`
`Override_SendSyncTime`	`-`	`-`	Sends Sync Time.
`Override_TrySetPossessHouseholdSleeping`	bInValue: `boolean`	`-`