C_HousingCatalog

namespaceavailable in: camelot

Status in wowlua

35 functions: 1 implemented, 0 recorded, 34 guessed. 8 events, 0 of them fired by the emulator on its own.

Functions

function	what it does	status
`CreateCatalogSearcher`	Creates a new instance of a HousingCatalog searcher; This can be used to asynchronously search/filter the HousingCatalog without affecting/being restricted by the filter state of other Housing Catalog UI displays `(): HousingCatalogSearcher`	implemented
`DeletePreviewCartDecor`	Removes previewed decor from the cart. · by wowlua `(decorGUID: string)`	guessed
`DestroyEntry`	Attempt to delete the entry from storage `(entryVariantID: HousingCatalogEntryVariantID, destroyAll: boolean)`	guessed
`GetAllFilterTagGroups`	Returns the groups of filter tags of the housing catalog. · by wowlua `(): HousingCatalogFilterTagGroupInfo[]`	guessed
`GetAllVariantInfosForEntry`	Returns variant info for all variants of a given catalog entry; Variants represent different visual modifications of the same base entry (ex: dyed versions) `(entryID: HousingCatalogEntryID): HousingCatalogEntryVariantInfo[]`	guessed
`GetBundleInfo`	Returns information about a housing bundle in the shop, or nothing. · by wowlua `(bundleCatalogShopProductID: number): HousingBundleInfo?`	guessed
`GetCartSizeLimit`	Returns the most items the housing market cart can hold. · by wowlua `(): number`	guessed
`GetCatalogCategoryAndSubcategoryNames`	If found, returns the names of the parent category and the specified subcategory `(subcategoryID: number): (string?, string?)`	guessed
`GetCatalogCategoryInfo`	Returns information about a housing catalog category, or nothing. · by wowlua `(categoryID: number): HousingCatalogCategoryInfo?`	guessed
`GetCatalogEntryDebugInfoForID`	Returns debug information about a housing catalog entry, by its ID. · by wowlua `not in Blizzard's documentation`	guessed
`GetCatalogEntryInfo`	Returns information about a housing catalog entry, or nothing. · by wowlua `(entryID: HousingCatalogEntryID): HousingCatalogEntryInfo?`	guessed
`GetCatalogEntryInfoByItem`	Returns the housing catalog entry of an item, or nothing. · by wowlua `(itemInfo: ItemInfo): HousingCatalogEntryInfo?`	guessed
`GetCatalogEntryInfoByRecordID`	Returns the housing catalog entry of a record, or nothing. · by wowlua `(entryType: HousingCatalogEntryType, recordID: number): HousingCatalogEntryInfo?`	guessed
`GetCatalogEntryRefundTimeStampByRecordID`	Returns the time until which a housing catalog entry can be refunded, or nothing. · by wowlua `(entryType: HousingCatalogEntryType, recordID: number): number?`	guessed
`GetCatalogEntryVariantInfo`	Returns information about a variant of a housing catalog entry, or nothing. · by wowlua `(entryVariantID: HousingCatalogEntryVariantID): HousingCatalogEntryVariantInfo?`	guessed
`GetCatalogSubcategoryInfo`	Returns information about a housing catalog subcategory, or nothing. · by wowlua `(subcategoryID: number): HousingCatalogSubcategoryInfo?`	guessed
`GetDecorMaxOwnedCount`	Returns the maximum total number of decor that can be in storage/in the house chest; Note that not all decor entries in storage count towards this limit (see GetDecorTotalOwnedCount) `(): number`	guessed
`GetDecorTotalOwnedCount`	Returns two counts of the decor the player owns. · by wowlua `(): (number, number)`	guessed
`GetDestroyableInstanceCount`	Returns the number of instances that can be to be destroyed in storage; These instances count towards the max storage limit `(entryVariantID: HousingCatalogEntryVariantID): number`	guessed
`GetFeaturedBundles`	Returns the featured housing bundles. · by wowlua `(): HousingBundleInfo[]`	guessed
`GetFeaturedSmallProducts`	Returns the featured small housing products. · by wowlua `(): HousingFeaturedSmallProductInfo[]`	guessed
`GetMarketInfoForDecor`	Returns market info for a specific decor. This is decor-only for now but should be extended to support entry type and recordID generically `(decorID: number): HousingMarketInfo?`	guessed
`HasFeaturedEntries`	Whether the housing catalog has featured entries. · by wowlua `(): boolean`	guessed
`HousingMarketActionAddToCart`	Adds a product to the housing market cart. · by wowlua `(productID: number, withPreview: boolean)`	guessed
`HousingMarketActionClearCart`	Empties the housing market cart. · by wowlua `()`	guessed
`HousingMarketActionRemoveFromCart`	Removes a product from the housing market cart. · by wowlua `(productID: number)`	guessed
`HousingMarketActionViewBundle`	Shows a bundle of the housing market. · by wowlua `(productID: number)`	guessed
`HousingMarketActionViewInStore`	Shows a housing market product in the shop. · by wowlua `(productID: number)`	guessed
`IsPreviewCartItemShown`	Whether previewed decor from the cart is shown. · by wowlua `(decorGUID: string): boolean`	guessed
`PromotePreviewDecor`	Turns previewed decor into placed decor and returns whether it succeeded. · by wowlua `(decorID: number, previewDecorGUID: string): boolean`	guessed
`RequestHousingMarketInfoRefresh`	Requests fresh housing market information from the server. · by wowlua `()`	guessed
`RequestHousingMarketRefundInfo`	Requests the housing market's refund information from the server. · by wowlua `()`	guessed
`SearchCatalogCategories`	Returns the IDs of the housing catalog categories that match the search. · by wowlua `(searchParams: HousingCategorySearchInfo): number[]`	guessed
`SearchCatalogSubcategories`	Returns the IDs of the housing catalog subcategories that match the search. · by wowlua `(searchParams: HousingCategorySearchInfo): number[]`	guessed
`SetPreviewCartItemShown`	Shows or hides previewed decor from the cart. · by wowlua `(decorGUID: string, shown: boolean)`	guessed

"by wowlua": no one documents this function, so wowlua wrote the description from its name, signature and behaviour.

Events

event	payload	fired by the emulator
`HOUSING_CATALOG_CATEGORY_UPDATED`	`categoryID: number`	not implemented
`HOUSING_CATALOG_SUBCATEGORY_UPDATED`	`subcategoryID: number`	not implemented
`HOUSING_DECOR_ADD_TO_PREVIEW_LIST`	`previewItemData: HousingPreviewItemData`	not implemented
`HOUSING_DECOR_PREVIEW_LIST_REMOVE_FROM_WORLD`	`decorGUID: string`	not implemented
`HOUSING_DECOR_PREVIEW_LIST_UPDATED`	`no payload`	not implemented
`HOUSING_REFUND_LIST_UPDATED`	`no payload`	not implemented
`HOUSING_STORAGE_ENTRY_UPDATED`	`entryVariantID: HousingCatalogEntryVariantID`	not implemented
`HOUSING_STORAGE_UPDATED`	`no payload`	not implemented

An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("HOUSING_CATALOG_CATEGORY_UPDATED").

Structures

HousingBundleDecorEntryInfo · decorID, quantity
HousingBundleInfo · productID, price, originalPrice?, nonDecorProducts, decorEntries, canPreview
HousingCatalogCategoryInfo · ID, orderIndex, name?, icon?, subcategoryIDs, anyStoredEntries
HousingCatalogEntryInfo · recordID, entryType, itemID?, name, asset?, iconTexture?, iconAtlas?, uiModelSceneID?, categoryIDs, subcategoryIDs, dataTagsByID, size, placementCost, totalNumStored, remainingRedeemable, totalNumPlaced, destroyableInstanceCount, isUniqueTrophy, isAllowedOutdoors, isAllowedIndoors, canCustomize, isPrefab, quality?, firstAcquisitionBonus, sourceText
HousingCatalogEntryVariantInfo · entryVariantID, numStored, dyeSlots
HousingCatalogSubcategoryInfo · ID, orderIndex, parentCategoryID, name?, icon?, anyStoredEntries
HousingCategorySearchInfo · withStoredEntriesOnly, includeFeaturedCategory, editorModeContext?
HousingFeaturedSmallProductInfo · entryVariantID?, productID, price, originalPrice?, canPreview
HousingMarketInfo · price, productID, bundleIDs
HousingPreviewItemData · decorGUID?, productID?, bundleCatalogShopProductID?, isBundleParent, isBundleChild, id, decorID, name, icon, price, salePrice?

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (HousingCatalogUI system, camelot 1.60.1). Descriptions: warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.