C_HousingCustomizeMode

namespaceavailable in: camelot

Status in wowlua

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

Functions

function	what it does	status
`ApplyDyeToSelectedDecor`	If a dyeable decor is selected, applies a specific dye color in a specific slot as a preview; See CommitDyesForSelectedDecor to actually save applied dye changes `(dyeSlotID: number, dyeColorID: number?)`	guessed
`ApplyPetToSelectedDecor`	If a decor is selected that supports pets, applies a specific petID to be shown on that decor `(petID: string?, petBehavior: HousingPetBehaviorType)`	guessed
`ApplyThemeToRoom`	Attempt to apply a specific theme set (aka style) to all applicable room components in the current room `(themeSetID: number)`	guessed
`ApplyThemeToSelectedRoomComponent`	Attempt to apply a specific theme set (aka style) to the currently selected room component only `(themeSetID: number)`	guessed
`ApplyWallpaperToAllWalls`	Attempt to apply a specific wallpaper (aka material/texture) to all applicable room components in the current room `(roomComponentTextureRecID: number)`	guessed
`ApplyWallpaperToSelectedRoomComponent`	Attempt to apply a specific wallpaper (aka material/texture) to the currently selected room component only `(roomComponentTextureRecID: number)`	guessed
`CancelActiveEditing`	Cancels all in-progress editing of the selected target, which will reset any unapplied customization changes and deselect the active target `()`	guessed
`ClearDyesForSelectedDecor`	Clears all previewed dye changes on the selected decor; Does not clear any already saved dyes that were previously applied `()`	guessed
`ClearTargetRoomComponent`	Deselect the currently selected room component, if there is one `()`	guessed
`CommitDyesForSelectedDecor`	Attempt to save all previewed dye changes made to the selected decor `(): boolean`	guessed
`GetHoveredDecorInfo`	Returns info for the placed decor instance currently being hovered, if there is one `(): HousingDecorInstanceInfo?`	guessed
`GetHoveredRoomComponentInfo`	Returns info for the room component currently being hovered, if there is one `(): HousingRoomComponentInstanceInfo?`	guessed
`GetNumDyesToRemoveOnSelectedDecor`	If a dyeable decor instance is selected, returns how many dye slots would be cleared on applying all currently previewed dye changes `(): number`	guessed
`GetNumDyesToSpendOnSelectedDecor`	If a dyeable decor instance is selected, returns how many dye items would be spent on applying all currently previewed dye changes `(): number`	guessed
`GetPreviewDyesOnSelectedDecor`	If a dyeable decor instance is selected, returns info structs for each new/changed dye currently being previewed `(): PreviewDyeSlotInfo[]`	guessed
`GetRecentlyUsedDyes`	Returns a list of ids for the dyes most recently applied by the player, if any `(): number[]`	guessed
`GetRecentlyUsedThemeSets`	Returns a list of ids for the theme sets (aka styles) most recently applied by the player, if any `(): number[]`	guessed
`GetRecentlyUsedWallpapers`	Returns a list of ids for the wallpapers most recently applied by the player, if any `(): number[]`	guessed
`GetSelectedDecorInfo`	Returns info for the decor instance that's currently selected, if there is one `(): HousingDecorInstanceInfo?`	guessed
`GetSelectedDecorPetInfo`	If a decor is selected that supports pets, gets petID and behavior type from decor `(): (string?, HousingPetBehaviorType)`	guessed
`GetSelectedRoomComponentInfo`	Returns info for the currently selected room component, if there is one `(): HousingRoomComponentInstanceInfo?`	guessed
`GetThemeSetInfo`	Returns the name of the specified theme set (aka style) if it exists `(themeSetID: number): string?`	guessed
`GetWallpapersForRoomComponentType`	Get all wallpapers (aka materials/textures) available for the selected room component type, if any `(type: HousingRoomComponentType): RoomComponentWallpaper[]`	guessed
`IsDecorSelected`	Returns true if a decor instance is currently selected for customization `(): boolean`	guessed
`IsHouseExteriorDoorHovered`	Returns true if the entry door of the house's exterior is currently being hovered `(): boolean`	guessed
`IsHoveringDecor`	Returns true if a placed decor instance is currently being hovered `(): boolean`	guessed
`IsHoveringRoomComponent`	Returns true if a room component is currently being hovered `(): boolean`	guessed
`IsRoomComponentSelected`	Returns true if a room component is currently selected for customization `(): boolean`	guessed
`RoomComponentSupportsVariant`	Check whether a specific room component supports a particular variant; What kind of id or enum 'variant' equates to is complicated, as it depends on the component type `(componentID: number, variant: number): boolean`	guessed
`RoomConnectionSupportsDoorType`	Check whether a specific room component, within a specific room, supports a particular doorType `(roomGUID: string, componentID: number, newDoortype: HousingRoomComponentDoorType): boolean`	guessed
`SetRoomComponentCeilingType`	Attempt to set a specific ceiling component, within a specific room, to a specific new ceiling type `(roomGUID: string, componentID: number, ceilingType: HousingRoomComponentCeilingType)`	guessed
`SetRoomComponentDoorType`	Attempt to set a specific door component, within a specific room, to a specific new door type `(roomGUID: string, componentID: number, newDoortype: HousingRoomComponentDoorType)`	guessed

Events

event	payload	fired by the emulator
`HOUSING_CUSTOMIZE_MODE_HOVERED_TARGET_CHANGED`	`hasHoveredTarget: boolean, targetType: HousingCustomizeModeTargetType`	not implemented
`HOUSING_CUSTOMIZE_MODE_SELECTED_TARGET_CHANGED`	`hasSelectedTarget: boolean, targetType: HousingCustomizeModeTargetType`	not implemented
`HOUSING_DECOR_CUSTOMIZATION_CHANGED`	`decorGUID: string`	not implemented
`HOUSING_DECOR_DYE_FAILURE`	`decorGUID: string, housingResult: HousingResult`	not implemented
`HOUSING_ROOM_COMPONENT_CUSTOMIZATION_CHANGED`	`roomGUID: string, componentID: number`	not implemented
`HOUSING_ROOM_COMPONENT_CUSTOMIZATION_CHANGE_FAILED`	`roomGUID: string, componentID: number, housingResult: HousingResult`	not implemented

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

Structures

HousingRoomComponentInstanceInfo · roomGUID, type, componentID, canBeCustomized, currentThemeSet?, availableThemeSets, currentWallpaper?, currentRoomComponentTextureRecID?, ceilingType, doorType
PreviewDyeSlotInfo · dyeColorID, dyeSlotID
RoomComponentWallpaper · name, roomComponentTextureRecID

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (HousingCustomizeModeUI system, camelot 1.60.1). Descriptions: warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗.