Skip to main content

FB1HouseholdInfo

Overview

  • Holds the complete runtime state of a household, including its name, member list, currency balances, site reference, business IDs, and various household flags.

Metadata

FieldValue
Kindstruct
EnvironmentB1 - Presentation
Categorystructs

Properties (21)

NameTypeDescription
CurrencyMaptable<string, integer>Map of currency IDs to current balances held by this household.
HouseholdBizIdsFB1EntityId[]List of business entity IDs owned by this household.
HouseholdBizSiteIdsFB1EntityId[]List of site entity IDs used by this household's businesses.
HouseholdDescriptionTextIdstringLocalized text ID for the household description.
HouseholdDtIdstringTransient data table ID for this household; not saved to disk.
HouseholdIdFB1EntityIdUnique entity ID identifying this household.
HouseholdMemberIdsFB1EntityId[]List of entity IDs for all members belonging to this household.
HouseholdNameDataFB1DisplayNameDataDisplay name data for the household name.
HouseholdTextureIdstringTexture ID representing this household's portrait or icon.
LastCustomizeTimeintegerGame tick timestamp of the last household customization.
LocatedCityIdstringID of the city this household belongs to.
ResidenceSiteEntityIdFB1EntityIdEntity ID of the residential site where this household lives.
ResidingSiteIdstringData table ID of the site where this household resides.
UnlockedObjectDataContainerFB1UnlockedRewardObjectDataContainerContainer tracking all reward objects unlocked by this household.
bCanMoveInbooleanWhether this household is eligible to move in to a new site.
bCanvasImportedbooleanWhether a canvas has been imported for this household.
bFamilyPortraitDirtybooleanWhether the family portrait needs to be retaken.
bGiveBonusCurrencybooleanWhether this household has been granted a bonus starting currency.
bIsEnableMortgagebooleanWhether mortgage functionality is enabled for this household.
bPauseAgingbooleanWhether aging is paused for all members of this household.
bPlayerCreatedbooleanWhether this household was created by the player (as opposed to auto-generated).