C_HousingDecor

namespaceavailable in: camelot

Status in wowlua

38 functions: 0 implemented, 0 recorded, 38 guessed. 11 events, 0 of them fired by the emulator on its own.

Functions

function	what it does	status
`AnyDecorPlacedInRoom`	Returns true if any decor objects are placed in a given room `(roomGUID: string): boolean`	guessed
`CancelActiveEditing`	Cancels all in-progress editing of the selected target, which will reset any unsaved changes and deselect the active target `()`	guessed
`CommitDecorMovement`	Attempt to save the changes made to the currently selected decor instance `()`	guessed
`EnterPreviewState`	Starts previewing decor. · by wowlua `()`	guessed
`ExitPreviewState`	Stops previewing decor. · by wowlua `()`	guessed
`GetAllMaxPlacementBudgets`	Returns the interior and exterior max decor placement budgets for the current owned house interior or plot; Can be increased via house level `(): (number[]?, number[]?)`	guessed
`GetAllPlacedDecor`	Placed Decor List APIs currently restricted due to being potentially very expensive operations, may be reworked & opened up in the future `(): HousingDecorInstanceListEntry[]`	guessed
`GetAllSpentPlacementBudgets`	Returns how much of the interior and exterior placement budgets for the current owned house interior or plot's decor budget have been spent `(): (number[]?, number[]?)`	guessed
`GetDecorAssignedPetName`	Returns pet name for the placed decor instance associated with the passed Decor GUID, if there is one `(decorGUID: string): string?`	guessed
`GetDecorCanAttachPet`	Whether a pet can be attached to the decor. · by wowlua `(decorID: number): boolean`	guessed
`GetDecorDebugInfoForGUID`	Returns debug information about a placed decor item, by its GUID. · by wowlua `not in Blizzard's documentation`	guessed
`GetDecorHyperlink`	Returns a chat link to the decor, or nothing. · by wowlua `(decorID: number): string?`	guessed
`GetDecorIcon`	Returns the decor's icon file ID, or nothing. · by wowlua `(decorID: number): number?`	guessed
`GetDecorInstanceInfoForGUID`	Returns info for the placed decor instance associated with the passed Decor GUID, if there is one `(decorGUID: string): HousingDecorInstanceInfo?`	guessed
`GetDecorName`	Returns the decor's name, or nothing. · by wowlua `(decorID: number): string?`	guessed
`GetHoveredDecorDebugInfo`	Returns debug information about the decor item under the cursor, or nil if there is none. Blizzard's PTR feedback tooltips use it. · by wowlua `not in Blizzard's documentation`	guessed
`GetHoveredDecorInfo`	Returns info for the placed decor instance currently being hovered, if there is one `(): HousingDecorInstanceInfo?`	guessed
`GetMaxPetPlacementBudget`	Returns the max pet decor placement budget for the current owned house interior or plot `(): number?`	guessed
`GetMaxPlacementBudget`	Returns the max decor placement budget for the current owned house interior or plot; Can be increased via house level `(): number?`	guessed
`GetNumDecorPlaced`	Returns the number of individual decor objects placed in the current house or plot; This is NOT the value used in placement budget calculations, see GetSpentPlacementBudget for that `(): number`	guessed
`GetNumPreviewDecor`	Returns the number of previewed decor items. · by wowlua `(): number`	guessed
`GetSelectedDecorDebugInfo`	Returns debug information about the selected decor item. · by wowlua `not in Blizzard's documentation`	guessed
`GetSelectedDecorInfo`	Returns info for the placed decor instance that's currently selected, if there is one `(): HousingDecorInstanceInfo?`	guessed
`GetSpentPetPlacementBudget`	Returns how much of the current owned house interior or plot's pet decor placement budget has been spent `(): number?`	guessed
`GetSpentPlacementBudget`	Returns how much of the current owned house interior or plot's decor placement budget has been spent; Different kinds of decor take up different budget amounts, so this value isn't an individual decor count, see GetNumDecorPlaced for that `(): number?`	guessed
`HasMaxPlacementBudget`	Returns whether there's a max decor placement budget available and active for the current player, in the current house interior or plot `(): boolean`	guessed
`IsDecorSelected`	Returns true if a placed decor instance is currently selected `(): boolean`	guessed
`IsGridVisible`	Whether the placement grid is shown. · by wowlua `(): boolean`	guessed
`IsHouseExteriorDoorHovered`	Returns true if the entry door of the house's exterior is currently being hovered `(): boolean`	guessed
`IsHouseExteriorHovered`	Returns true if the house's exterior is currently being hovered `(): boolean`	guessed
`IsHoveringDecor`	Returns true if a placed decor instance is currently being hovered `(): boolean`	guessed
`IsModeDisabledForPreviewState`	Whether the house editor mode is unavailable while previewing decor. · by wowlua `(mode: HouseEditorMode): boolean`	guessed
`IsPreviewState`	Whether decor is being previewed. · by wowlua `(): boolean`	guessed
`RemovePlacedDecorEntry`	Placed Decor List APIs currently restricted due to being potentially very expensive operations, may be reworked & opened up in the future `(decorGUID: string)`	guessed
`RemoveSelectedDecor`	Attempt to return the currently selected decor instance back to the house chest `()`	guessed
`SetGridVisible`	Shows or hides the placement grid. · by wowlua `(gridVisible: boolean)`	guessed
`SetPlacedDecorEntryHovered`	Placed Decor List APIs currently restricted due to being potentially very expensive operations, may be reworked & opened up in the future `(decorGUID: string, hovered: boolean)`	guessed
`SetPlacedDecorEntrySelected`	Placed Decor List APIs currently restricted due to being potentially very expensive operations, may be reworked & opened up in the future `(decorGUID: string, selected: 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
`HOUSE_DECOR_ADDED_TO_CHEST`	`decorGUID: string, decorID: number`	not implemented
`HOUSE_EXTERIOR_POSITION_FAILURE`	`housingResult: HousingResult`	not implemented
`HOUSE_EXTERIOR_POSITION_SUCCESS`	`no payload`	not implemented
`HOUSING_DECOR_GRID_VISIBILITY_STATUS_CHANGED`	`isGridVisible: boolean`	not implemented
`HOUSING_DECOR_PLACE_FAILURE`	`housingResult: HousingResult`	not implemented
`HOUSING_DECOR_PLACE_SUCCESS`	`decorGUID: string, size: HousingCatalogEntrySize, isNew: boolean, isPreview: boolean`	not implemented
`HOUSING_DECOR_PREVIEW_STATE_CHANGED`	`isPreviewState: boolean`	not implemented
`HOUSING_DECOR_REMOVED`	`decorGUID: string`	not implemented
`HOUSING_DECOR_SELECT_RESPONSE`	`result: HousingResult`	not implemented
`HOUSING_NEW_DECOR_PLACE_COMPLETE`	`decorGUID: string`	not implemented
`HOUSING_NUM_DECOR_PLACED_CHANGED`	`no payload`	not implemented

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

Structures

HousingDecorInstanceListEntry · decorGUID, name

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (HousingDecorUI 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.