C_HousingBasicMode
namespaceavailable in: camelotStatus in wowlua
22 functions: 0 implemented, 0 recorded, 22 guessed. 6 events, 0 of them fired by the emulator on its own.
Functions
| function | what it does | status |
|---|---|---|
CancelActiveEditing | Cancels all in-progress editing of the selected target, which will reset any unsaved changes and deselect the active target; Un-placed decor will be returned to the house chest() | guessed |
CommitDecorMovement | Attempt to save the changes made to the currently selected decor instance() | guessed |
CommitHouseExteriorPosition | Attempt to save the changes made to the House Exterior's position within the plot() | guessed |
FinishPlacingNewDecor | Finishes placing the new decor. · by wowlua() | guessed |
GetHoveredDecorInfo | Returns info for the placed decor instance currently being hovered, if there is one(): HousingDecorInstanceInfo? | guessed |
GetSelectedDecorInfo | Returns info for the decor instance that's currently selected, if there is one(): HousingDecorInstanceInfo? | guessed |
IsDecorSelected | Returns true if a decor instance is currently selected and being dragged(): boolean | guessed |
IsFreePlaceEnabled | When free place is enabled, collision checks while dragging decor/the house exterior are ignored(): boolean | guessed |
IsGridSnapEnabled | Whether decor snaps to the grid. · by wowlua(): boolean | guessed |
IsGridVisible | Whether the placement grid is shown. · by wowlua(): boolean | guessed |
IsHouseExteriorHovered | Returns true if the house's exterior is currently being hovered(): boolean | guessed |
IsHouseExteriorSelected | Returns true if the house's exterior is currently selected and being moved(): boolean | guessed |
IsHoveringDecor | Returns true if a placed decor instance is currently being hovered(): boolean | guessed |
IsPlacingNewDecor | Whether the player is placing new decor. · by wowlua(): boolean | guessed |
RemoveSelectedDecor | Attempt to return the currently selected decor instance back to the house chest() | guessed |
RotateDecor | Rotates the currently selected decor along a single axis; For wall decor, rotates such that the object stays flat against its current wall; For all other decor, rotates around the Z (vertical) axis(rotDegrees: number) | guessed |
RotateHouseExterior | Rotates the House Exterior around the Z (vertical) axis(rotDegrees: number) | guessed |
SetFreePlaceEnabled | Set whether free place is enabled; When free place is enabled, collision checks while dragging decor/the house exterior are ignored(freePlaceEnabled: boolean) | guessed |
SetGridSnapEnabled | Sets whether decor snaps to the grid. · by wowlua(isGridSnapEnabled: boolean) | guessed |
SetGridVisible | Shows or hides the placement grid. · by wowlua(gridVisible: boolean) | guessed |
StartPlacingNewDecor | Starts placing new decor from the catalog. · by wowlua(catalogEntryVariantID: HousingCatalogEntryVariantID) | guessed |
StartPlacingPreviewDecor | Starts placing decor as a preview. · by wowlua(decorRecordID: number, bundleCatalogShopProductID: number?) | 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_BASIC_MODE_HOVERED_TARGET_CHANGED | hasHoveredTarget: boolean, targetType: HousingBasicModeTargetType | not implemented |
HOUSING_BASIC_MODE_PLACEMENT_FLAGS_UPDATED | targetType: HousingBasicModeTargetType, activeFlags: HousingDecorPlacementRestriction | not implemented |
HOUSING_BASIC_MODE_SELECTED_TARGET_CHANGED | hasSelectedTarget: boolean, targetType: HousingBasicModeTargetType, isPreview: boolean | not implemented |
HOUSING_DECOR_FREE_PLACE_STATUS_CHANGED | isFreePlaceEnabled: boolean | not implemented |
HOUSING_DECOR_GRID_SNAP_OCCURRED | no payload | not implemented |
HOUSING_DECOR_GRID_SNAP_STATUS_CHANGED | isGridSnapEnabled: boolean | not implemented |
An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("HOUSING_BASIC_MODE_HOVERED_TARGET_CHANGED").
sources
Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (HousingBasicModeUI 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.