~/forever/addon-api/table/HousingCatalogEntryInfo
HousingCatalogEntryInfo
documented structure · HousingCatalogUI
Structure HousingCatalogEntryInfoBase information about an object in the Catalog; For info for a specific owned stack of this object, see HousingCatalogEntryVariantInfo
──FIELDS
- recordID
- number
- entryType
- HousingCatalogEntryType
- itemID
- number, optional
- name
- cstring
- asset
- ModelAsset, optional (3D model asset for displaying in the UI; May be nil if the entry doesn't have a model, or has one that isn't supported by UI model scenes)
- iconTexture
- FileAsset, optional (Entry icon in the form of a texture file; Catalog entries should have either this OR an iconAtlas set)
- iconAtlas
- textureAtlas, optional (Entry icon in the form a texture atlas element; Catalog entries should have either this OR an iconTexture set)
- uiModelSceneID
- number, optional (Specific UI model scene ID to use when previewing this entry's 3D model; If not set, the default catalog model scene is used)
- categoryIDs
- table<number>
- subcategoryIDs
- table<number>
- dataTagsByID
- LuaValueVariant (Simple localized 'tag' strings that are primarily used for things like categorization and filtering)
- size
- HousingCatalogEntrySize
- placementCost
- number (How much of the applicable budget placing this entry would cost (if any))
- totalNumStored
- number (The total number of instances of this entry that exist in storage across all variants; Does not include unredeemed instances (see remainingRedeemable))
- remainingRedeemable
- number (The number of unredeemed instances of this entry that exist in storage; Some auto-awarded housing objects are granted in this 'lazily-instantiated' way, and will be 'redeemed' on first being placed)
- totalNumPlaced
- number (The total number of instances of this entry that have been placed across all of the player's houses and plots, across all variants)
- destroyableInstanceCount
- number (The number of instances that can be destroyed for this entry.)
- isUniqueTrophy
- bool (This decor is flagged to display as a unique trophy item.)
- isAllowedOutdoors
- bool (True if this entry is something that is allowed to be placed outside, within a plot)
- isAllowedIndoors
- bool (True if this entry is something that is allowed to be placed indoors, within a house interior)
- canCustomize
- bool (True if this entry is something that can be customized; Kinds of customization vary depending on the entry type)
- isPrefab
- bool
- quality
- ItemQuality, optional
- firstAcquisitionBonus
- number (House XP that can be gained upon acquiring this entry for the first time)
- sourceText
- cstring (Describes specific sources this entry may be gained from; Faction-specific sources may or may not be included based on the current player's faction)
──VERSION HISTORY
Present since at least 1.60.1.70707, the first build we track.