Skip to main content

B1HouseholdInfo

  • Holds the complete runtime state of a household, including its name, member list,
    * currency balances, site reference, business IDs, and various household flags.
PropertyTypeDescriptionMetadata
UnlockedObjectDataContainerFB1UnlockedRewardObjectDataContainerContainer tracking all reward objects unlocked by this household.
HouseholdNameDataFB1DisplayNameDataDisplay name data for the household name.
HouseholdDescriptionTextIdFStringLocalized text ID for the household description.
HouseholdIdFB1EntityIdUnique entity ID identifying this household.
HouseholdMemberIdsTArrayList of entity IDs for all members belonging to this household.
CurrencyMapTMapMap of currency IDs to current balances held by this household.
ResidenceSiteEntityIdFB1EntityIdEntity ID of the residential site where this household lives.
ResidingSiteIdFNameData table ID of the site where this household resides.
LocatedCityIdFNameID of the city this household belongs to.
HouseholdBizIdsTArrayList of business entity IDs owned by this household.
HouseholdBizSiteIdsTArrayList of site entity IDs used by this household's businesses.
HouseholdDtIdFNameTransient data table ID for this household; not saved to disk.
bCanMoveInboolWhether this household is eligible to move in to a new site.
HouseholdTextureIdFNameTexture ID representing this household's portrait or icon.
bGiveBonusCurrencyboolWhether this household has been granted a bonus starting currency.
LastCustomizeTimeint64Game tick timestamp of the last household customization.
bPauseAgingboolWhether aging is paused for all members of this household.
bCanvasImportedboolWhether a canvas has been imported for this household.
bPlayerCreatedboolWhether this household was created by the player (as opposed to auto-generated).
bIsEnableMortgageboolWhether mortgage functionality is enabled for this household.
bFamilyPortraitDirtyboolWhether the family portrait needs to be retaken.