FB2HouseholdManager
Overview
- Household manager that runs per-tick or OnDayChanged computations for households. Also handles waiting-household logic here.
Metadata
| Field | Value |
|---|---|
| Kind | system |
| Environment | B2 - Simulation |
| Category | systems |
| Extends | FB2ManagerBase |
| Require | require('Systems.B2HouseholdManager') |
Properties (3)
| Name | Type | Description |
|---|---|---|
Households | table<FB1EntityId, FB2HouseholdContext> | |
OnDayChangedUpdateList | FB1EntityId[] | List of Households that need OnDayChanged updates. |
RegistedHouseholdDtIds | table<string, boolean> | Info on HouseholdIds that have been created at least once. |
Functions (13)
| Function | Parameters | Returns | Description |
|---|---|---|---|
GetHouseholdCount | - | integer | Returns Household Count. |
GetType | - | EB2ManagerType | Returns Type. |
GetValidInstance (static) | - | FB2HouseholdManager | Returns Valid Instance. |
IsAgingPaused | InHouseholdId: FB1EntityId | boolean | Returns whether Aging Paused. |
IsTickable | - | boolean | Returns whether Tickable. |
RegisterHousehold | InHouseholdId: FB1EntityId | - | Registers Household. |
ResolveHousehold | InNewGamePath: string | - | |
SetPauseAging | InHouseholdId: FB1EntityId, bInValue: boolean, bInReason: string | boolean | Sets Pause Aging. |
StaticIsAgingPaused (static) | InHouseholdId: FB1EntityId | boolean | |
StaticRegisterHousehold (static) | InHouseholdId: FB1EntityId | - | |
StaticSetPauseAging (static) | InHouseholdId: FB1EntityId, bInValue: boolean, InReason: string | boolean | |
StaticUnregisterHousehold (static) | InHouseholdId: FB1EntityId | - | |
UnregisterHousehold | InHouseholdId: FB1EntityId | - | Unregisters Household. |
Override points (5)
Implement these in Lua as FB2HouseholdManager.Override_Name = function(...) end.
| Function | Parameters | Returns | Description |
|---|---|---|---|
Override_RegisterHousehold | InHouseholdId: FB1EntityId | - | Registers Household. |
Override_ResolveHousehold | InNewGamePath: string | - | |
Override_StaticRegisterHousehold (static) | InHouseholdId: FB1EntityId | - | |
Override_StaticUnregisterHousehold (static) | InHouseholdId: FB1EntityId | - | |
Override_UnregisterHousehold | InHouseholdId: FB1EntityId | - | Unregisters Household. |