FB2HouseholdBizManager

Overview

Manages household businesses (self-employment).

Metadata

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

Properties (6)

Name	Type	Description
`AccommodationCrowdCheckInTaskId`	`FB1TimeTaskId`
`BizMaxExp`	`integer`
`CustomerCandidates`	`FB1EntityIdArray`
`HomelessSiteMap`	`table<FB1EntityId, string>`
`HouseholdBizIdMap`	`table<FB1EntityId, FB1EntityId>`
`RecentAccommodationGuestHouseholdIds`	`FB1EntityId[]`

Functions (42)

Function	Parameters	Returns	Description
`AutoRegisterDefaultHouseholdBiz`	Self: `FB2HouseholdBizManager`, Site: `FB2Site`, bSkipReset: `boolean`	`-`
`ClearCustomerCandidates`	`-`	`-`	Clears Customer Candidates.
`CustomerIsInBizSite` (static)	InCharacterEntityId: `FB1EntityId`	`boolean`
`DepartEmployeeFromAllHouseholdBiz`	InEmployeeId: `FB1EntityId`	`-`
`DestroyHouseholdBiz`	InHouseholdBizId: `FB1EntityId`	`-`
`FindHouseholdBizByHousehold`	Self: `FB2HouseholdBizManager`, HouseholdId: `FB1EntityId`	`-`	Finds and returns Household Biz By Household.
`FindHouseholdBizBySiteEntityId`	InSiteEntityId: `FB1EntityId`	`FB1EntityId`	Finds and returns Household Biz By Site Entity Id.
`FindHouseholdBizBySiteEntityIdPtr`	InSiteEntityId: `FB1EntityId`	`FB2HouseholdBiz`	Finds and returns Household Biz By Site Entity Id Ptr.
`FindOldestPlacedAccommodationGuestHousehold`	InCandidateHouseholdIds: `FB1EntityId[]`	`FB1EntityId`	Finds and returns Oldest Placed Accommodation Guest Household.
`FindSiteEntityIdByHouseholdBiz`	InHouseholdBizId: `FB1EntityId`	`FB1EntityId`	Finds and returns Site Entity Id By Household Biz.
`ForceEndBusiness`	InHouseholdBizId: `FB1EntityId`, InReason: `EB1HouseholdBizEndDailyBusinessReason`	`-`
`GenerateHouseholdBiz`	Self: `FB2HouseholdBizManager`, OwnerId: `FB1EntityId`	`-`	Generates Household Biz.
`Get`	`-`	`-`
`GetActiveBizCount`	`-`	`integer`	Returns Active Biz Count.
`GetBizMaxExp`	`-`	`integer`	Returns Biz Max Exp.
`GetSingleCustomerCandidate`	`-`	`FB1EntityId`	Returns Single Customer Candidate.
`GetType`	`-`	`EB2ManagerType`	Returns Type.
`IsAccommodationGuestHouseholdOnCooldown`	InHouseholdEntityId: `FB1EntityId`	`boolean`	Returns whether Accommodation Guest Household On Cooldown.
`IsHouseholdBizRegistered`	InHouseholdBizEntityId: `FB1EntityId`	`boolean`	Returns whether Household Biz Registered.
`IsRegisteredStallObject`	InStallEntityId: `FB1EntityId`	`boolean`	Returns whether Registered Stall Object.
`IsRegisteredStallObjectBySite`	InStallEntityId: `FB1EntityId`, InSiteEntityId: `FB1EntityId`	`boolean`	Returns whether Registered Stall Object By Site.
`IsTickable`	`-`	`boolean`	Returns whether Tickable.
`IsWithinBizWorkTime`	InHouseholdBizId: `FB1EntityId`	`boolean`	Returns whether Within Biz Work Time.
`ManualEndDayBusiness`	InHouseholdBizId: `FB1EntityId`	`-`
`PurchaseHouseholdBizSite`	InHouseholdEntityId: `FB1EntityId`, InSiteId: `string`, InOwnerId: `FB1EntityId`	`-`
`RecordAccommodationGuestHousehold`	InHouseholdEntityId: `FB1EntityId`	`-`
`RefreshAccommodationBookingBlockFlags`	InHouseholdEntityId: `FB1EntityId`	`-`
`RegisterStallObject`	InStallEntityId: `FB1EntityId`, InSiteEntityId: `FB1EntityId`	`boolean`	Registers a stall object.
`ResolveHouseholdBiz`	`-`	`-`
`SellHouseholdBiz`	InHouseholdEntityId: `FB1EntityId`, InHouseholdBizEntityId: `FB1EntityId`	`-`
`SellHouseholdBizSiteBySite`	Self: `FB2HouseholdBizManager`, HouseholdEntityId: `FB1EntityId`, Site: `FB2Site`, bRegisterDefaultHouseholdBiz: `boolean`	`-`
`SellHouseholdBizSiteBySiteId`	InHouseholdEntityId: `FB1EntityId`, InSiteId: `string`, bRegisterDefaultHoudholdBiz: `boolean`	`-`
`SendAddTimeAlert` (static)	InEntityId: `FB1EntityId`, InTotalMinutes: `number`, InEndTicks: `integer`	`-`	Sends Add Time Alert.
`SendRemoveTimeAlert` (static)	InEntityId: `FB1EntityId`	`-`	Sends Remove Time Alert.
`SimulateCustomerForNonNearSites`	InNearSiteEntityIds: `table<FB1EntityId, boolean>`	`-`	Runs a simplified customer simulation for operating businesses not included in NearSite.
`StaticFindHouseholdBizBySiteEntityId` (static)	InSiteEntityId: `FB1EntityId`	`FB1EntityId`
`StaticFindHouseholdBizBySiteEntityIdPtr` (static)	InSiteEntityId: `FB1EntityId`	`FB2HouseholdBiz`
`StaticFindSiteEntityIdByHouseholdBiz` (static)	InHouseholdBizId: `FB1EntityId`	`FB1EntityId`
`StaticGetSingleCustomerCandidate` (static)	`-`	`FB1EntityId`
`TransferHouseholdBizOwnership`	Self: `FB2HouseholdBizManager`, HouseholdBiz: `FB2HouseholdBiz`, ToEntityId: `FB1EntityId`, OverrideHouseholdId: `FB1EntityId`	`-`
`TrySpawnAccommodationCrowdGuests`	`-`	`-`
`UnregisterStallObject`	InStallEntityId: `FB1EntityId`, InSiteEntityId: `FB1EntityId`	`boolean`	Unregisters Stall Object.

Override points (31)

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

Function	Parameters	Returns	Description
`Override_CustomerIsInBizSite` (static)	InCharacterEntityId: `FB1EntityId`	`boolean`
`Override_DepartEmployeeFromAllHouseholdBiz`	InEmployeeId: `FB1EntityId`	`-`
`Override_DestroyHouseholdBiz`	InHouseholdBizId: `FB1EntityId`	`-`
`Override_FindHouseholdBizBySiteEntityId`	InSiteId: `FB1EntityId`	`FB1EntityId`	Finds and returns Household Biz By Site Entity Id.
`Override_FindHouseholdBizBySiteEntityIdPtr`	InSiteId: `FB1EntityId`	`FB2HouseholdBiz`	Finds and returns Household Biz By Site Entity Id Ptr.
`Override_FindOldestPlacedAccommodationGuestHousehold`	InCandidateHouseholdIds: `FB1EntityId[]`	`FB1EntityId`	Finds and returns Oldest Placed Accommodation Guest Household.
`Override_FindSiteEntityIdByHouseholdBiz`	InHouseholdBizId: `FB1EntityId`	`FB1EntityId`	Finds and returns Site Entity Id By Household Biz.
`Override_ForceEndBusiness`	InHouseholdBizId: `FB1EntityId`, InReason: `EB1HouseholdBizEndDailyBusinessReason`	`-`
`Override_IsAccommodationGuestHouseholdOnCooldown`	InHouseholdEntityId: `FB1EntityId`	`boolean`	Returns whether Accommodation Guest Household On Cooldown.
`Override_ManualEndDayBusiness`	InHouseholdBizId: `FB1EntityId`	`-`
`Override_OnChangeWorkTime`	InHouseholdBizEntityId: `InHouseholdBizEntityId`, InOldTimeData: `InOldTimeData`, InNewTimeData: `InNewTimeData`	`-`	Callback invoked on Change Work Time.
`Override_OnChangedGameConfigModifierValue`	InModifierKey: `InModifierKey`, InModifierValue: `InModifierValue`	`-`	Regenerates the customer spawn list of operating businesses when density changes.
`Override_OnDayChanged`	InPrevTime: `InPrevTime`, InCurrTime: `InCurrTime`	`-`	Callback invoked on Day Changed.
`Override_OnEnterBizSite_Customer`	InCharacterEntityId: `InCharacterEntityId`, InSiteEntityId: `InSiteEntityId`	`-`	Called when a customer enters a business site.
`Override_OnHourChanged`	InPrevTime: `InPrevTime`, InCurrTime: `InCurrTime`	`-`	Callback invoked on Hour Changed.
`Override_OnLeaveBizSite_Customer`	InCharacterEntityId: `InCharacterEntityId`, InSiteEntityId: `InSiteEntityId`	`-`	Callback invoked on Leave Biz Site_Customer.
`Override_OnMinuteChanged`	InPrevTime: `InPrevTime`, InCurrTime: `InCurrTime`	`-`	Callback invoked on Minute Changed.
`Override_PurchaseHouseholdBizSite`	InHouseholdEntityId: `FB1EntityId`, InSiteId: `string`, InOwnerId: `FB1EntityId`	`-`
`Override_RecordAccommodationGuestHousehold`	InHouseholdEntityId: `FB1EntityId`	`-`
`Override_RefreshAccommodationBookingBlockFlags`	InHouseholdEntityId: `FB1EntityId`	`-`
`Override_RegisterStallObject`	InStallEntityId: `FB1EntityId`, InSiteEntityId: `FB1EntityId`	`boolean`	Registers a stall object.
`Override_ResolveHouseholdBiz`	`-`	`-`
`Override_SellHouseholdBiz`	InHouseholdEntityId: `FB1EntityId`, InHouseholdBizEntityId: `FB1EntityId`	`-`
`Override_SendAddTimeAlert` (static)	InEntityId: `FB1EntityId`, InTotalMinutes: `number`, InEndTicks: `integer`	`-`	Sends Add Time Alert.
`Override_SendRemoveTimeAlert` (static)	InEntityId: `FB1EntityId`	`-`	Sends Remove Time Alert.
`Override_SimulateCustomerForNonNearSites`	InNearSiteEntityIds: `table<FB1EntityId, boolean>`	`-`	Runs a simplified customer simulation for operating businesses not included in NearSite.
`Override_StaticFindHouseholdBizBySiteEntityId` (static)	InSiteId: `FB1EntityId`	`FB1EntityId`
`Override_StaticFindHouseholdBizBySiteEntityIdPtr` (static)	InSiteEntityId: `FB1EntityId`	`FB2HouseholdBiz`
`Override_StaticFindSiteEntityIdByHouseholdBiz` (static)	InHouseholdBizId: `FB1EntityId`	`FB1EntityId`
`Override_TrySpawnAccommodationCrowdGuests`	`-`	`-`
`Override_UnregisterStallObject`	InStallEntityId: `FB1EntityId`, InSiteEntityId: `FB1EntityId`	`boolean`	Unregisters Stall Object.