FB2Household

Overview

No description available.

Metadata

Field	Value
Kind	`struct`
Environment	B2 - Simulation
Category	`structs`
Extends	`FB2Entity`

Properties (21)

Name	Type	Description
`ActiveNeighborhoodStories`	`table<string, boolean>`	Neighborhood stories: list of active story IDs.
`AutonomyOption`	`FB1AutonomyOption`
`HouseholdBizEntityIds`	`FB1EntityId[]`
`HouseholdBizSiteEntityIds`	`FB1EntityId[]`
`HouseholdDescriptionTextId`	`string`
`HouseholdDtId`	`string`
`HouseholdNameData`	`FB1DisplayNameData`
`HouseholdTextureId`	`string`
`LastCustomizeTime`	`integer`	The time the user last customized.
`Members`	`FB1EntityId[]`
`NewUnlockedRewardObjects`	`table<string, boolean>`
`ResidanceSiteId`	`FB1EntityId`
`SaleObjectList`	`FB1EntityId[]`	Objects for sale are managed by the family.
`UnlockedObjectDataContainer`	`FB1UnlockedRewardObjectDataContainer`
`bCanMoveIn`	`boolean`	Distinguishes whether the family can move in (e.g. a code-made single-person family for a job-role NPC); not about whether it currently has a residence.
`bCanvasImported`	`boolean`
`bEverPossessed`	`boolean`	Whether the family was ever possessed.
`bFamilyPortraitDirty`	`boolean`
`bIsPossessedToday`	`boolean`	Whether the family was played today.
`bPlayerCreated`	`boolean`
`bUseDirectTaxPayment`	`boolean`	Whether utility bills are paid manually.

Functions (58)

Function	Parameters	Returns	Description
`ActivateNeighborhoodStory`	InStoryId: `string`	`-`
`AddHouseholdBizEntityId`	InHouseholdBizId: `FB1EntityId`	`-`	Adds Household Biz Entity Id.
`AddHouseholdBizSiteEntityId`	InSiteEntityId: `FB1EntityId`	`-`	Adds Household Biz Site Entity Id.
`AddHouseholdMember`	InCharacterId: `FB1EntityId`, InForce: `boolean`	`boolean`	Adds Household Member.
`AddHouseholdMembers`	InCharacterIds: `FB1EntityId[]`, InForce: `boolean`	`-`	Adds Household Members.
`AddSaleObject`	InEntityId: `FB1EntityId`	`-`	Adds Sale Object.
`AddUnlockRewardObject`	InObjectId: `string`, InUnlockRewardReason: `EB1UnlockRewardReason`, bSendPacket: `boolean`	`-`	Adds Unlock Reward Object.
`CanAddHouseholdMember`	InCharacterId: `FB1EntityId`	`boolean`	Returns whether it can Add Household Member.
`CanMergeHouseholdMember`	InCharacterId: `FB1EntityId`, MaxFamilyMemberCount: `integer`	`boolean`	Returns whether it can Merge Household Member.
`ChangeResidanceSite`	InResidenceSiteId: `FB1EntityId`	`-`
`DeactivateNeighborhoodStory`	InStoryId: `string`	`-`
`EvictSite`	bIsResetPrevSite: `boolean`	`-`
`GetAutonomyOption`	`-`	`FB1AutonomyOption`	Returns Autonomy Option.
`GetCanMoveIn`	`-`	`boolean`	Returns Can Move In.
`GetCityMovePolicyMap`	InCityMoveDataPolicyType: `EB1CityMoveDataPolicyType`	`table<string, EB1CityMoveDataPolicy>`	Returns City Move Policy Map.
`GetDefaultCityMoveDataPolicy`	`-`	`EB1CityMoveDataPolicy`	Returns Default City Move Data Policy.
`GetExportData`	`-`	`string`	Returns Export Data.
`GetHouseholdBizEntityIdList`	`-`	`FB1EntityId[]`	Returns Household Biz Entity Id List.
`GetHouseholdBizSiteEntityIdList`	`-`	`FB1EntityId[]`	Returns Household Biz Site Entity Id List.
`GetHouseholdDtId`	`-`	`string`	Returns Household Dt Id.
`GetHouseholdGrowthStepMemberCount`	InGrowthStep: `EB1GrowthStep`	`integer`	Returns Household Growth Step Member Count.
`GetHouseholdInfo`	`-`	`FB1HouseholdInfo`	Returns Household Info.
`GetHouseholdMemberCount`	`-`	`integer`	Returns Household Member Count.
`GetHouseholdMemberCountWithPregnancy`	`-`	`integer`	Returns Household Member Count With Pregnancy.
`GetHouseholdMembers`	`-`	`FB1EntityId[]`	Returns Household Members.
`GetHouseholdName`	`-`	`string`	Returns Household Name.
`GetHouseholdNameData`	`-`	`FB1DisplayNameData`	Returns Household Name Data.
`GetResidanceSiteId`	`-`	`FB1EntityId`	Returns Residance Site Id.
`HasUnlockedRewardObject`	InObjectId: `string`	`boolean`	Returns whether it has Unlocked Reward Object.
`InitData`	InHouseholdInfo: `FB1HouseholdInfo`	`-`	Initializes Data.
`IsEverPossessed`	`-`	`boolean`	Returns whether Ever Possessed.
`IsHouseholdMember`	InEntityId: `FB1EntityId`	`boolean`	Returns whether Household Member.
`IsNeighborhoodStoryActive`	InStoryId: `string`	`boolean`	Returns whether Neighborhood Story Active.
`IsPlayerCreated`	`-`	`boolean`	Returns whether Player Created.
`IsPossessedToday`	`-`	`boolean`	Returns whether Possessed Today.
`IsSleepingAllMember`	`-`	`boolean`	Returns whether Sleeping All Member.
`IsUseDirectTaxPayment`	`-`	`boolean`	Returns whether Use Direct Tax Payment.
`OnDayChanged`	`-`	`-`	Callback invoked on Day Changed.
`OnOwnerHouseholdPossessed`	`-`	`-`	Callback invoked on Owner Household Possessed.
`RefreshHouseholdMemberInfo`	`-`	`-`
`RemoveHouseholdBizEntityId`	InHouseholdBizId: `FB1EntityId`	`-`	Removes Household Biz Entity Id.
`RemoveHouseholdBizSiteEntityId`	InSiteEntityId: `FB1EntityId`	`-`	Removes Household Biz Site Entity Id.
`RemoveHouseholdMember`	InCharacterId: `FB1EntityId`, OutDestoryFamily: `boolean`, bSendUpdate: `boolean`	`-`	Removes Household Member.
`RemoveSaleObject`	InEntityId: `FB1EntityId`	`-`	Removes Sale Object.
`SendRemoveHouseholdBizInfoByEntityId`	InRemoveEntityId: `FB1EntityId`	`-`	Sends Remove Household Biz Info By Entity Id.
`SendRemoveHouseholdBizInfoByEntityIds`	InEntityIds: `FB1EntityId[]`	`-`	Sends Remove Household Biz Info By Entity Ids.
`SendUnlockRewardObject`	InUnlockRewardReason: `EB1UnlockRewardReason`	`-`	Sends Unlock Reward Object.
`SendUpdateHouseholdBizInfo`	`-`	`-`	Sends Update Household Biz Info.
`SendUpdateHouseholdInfo`	bForceSendPacket: `boolean`	`-`	Sends Update Household Info.
`SetCanMoveIn`	InCanMoveIn: `boolean`	`-`	Sets Can Move In.
`SetCustomHouseholdName`	InCustomHouseholdName: `string`	`-`	Sets Custom Household Name.
`SetHouseholdName`	InDisplayNameData: `FB1DisplayNameData`	`-`	Sets Household Name.
`SetPlayerCreatedFlag`	`-`	`-`	Sets Player Created Flag.
`SetResidanceSiteId`	InResidanceSiteId: `FB1EntityId`, bIsResetPrevSite: `boolean`, bIsGhost: `boolean`	`-`	Sets Residance Site Id.
`SetUseDirectTaxPayment`	InUseDirectTaxPayment: `boolean`	`-`	Sets Use Direct Tax Payment.
`SyncUnlockRewardObject`	`-`	`-`
`UpdateData`	InHouseholdInfo: `FB1HouseholdInfo`	`-`	Updates Data.
`UpdateLastCustomizeTime`	`-`	`-`	Updates Last Customize Time.