Wow API Housing

Housing API (Retail — Patch 12.0.0)

Comprehensive reference for the player housing system, brand new in Patch 12.0.0.

Source: https://warcraft.wiki.gg/wiki/World_of_Warcraft_API Current as of: Patch 12.0.0 (Build 65655) — January 28, 2026 Scope: Retail only. This entire system is new in 12.0.0.

Scope

• HousingUI — Core housing system frame and state
• C_HouseEditorUI — Placement and editing (position, rotate, scale)
• C_HousingCatalog — Decoration catalog browsing
• HousingBasicModeUI — Simplified placement mode
• HousingCleanupModeUI — Bulk cleanup/removal mode
• HousingCustomizeModeUI — Customization mode
• HousingDecorUI — Decoration management
• HousingExpertModeUI — Advanced/expert placement
• C_HouseExteriorUI — Exterior appearance customization
• HousingLayoutUI — Layout save/load
• C_HousingNeighborhood — Neighborhoods and visiting
• C_NeighborhoodInitiative — Community initiative goals
• CatalogShop — Housing shop/catalog purchase system

HousingUI — Core Housing System

C_HouseEditorUI — Placement & Editing

The editor is the core system for placing, moving, rotating, and scaling decorations.

Object Selection & Manipulation

Placement

Undo/Redo

C_HousingCatalog — Decoration Catalog

HousingBasicModeUI — Simplified Mode

HousingCleanupModeUI — Cleanup Mode

HousingCustomizeModeUI — Customization

HousingDecorUI — Decoration Management

HousingExpertModeUI — Expert Placement

C_HouseExteriorUI — Exterior Customization

HousingLayoutUI — Layout Save/Load

C_HousingNeighborhood — Neighborhoods

C_NeighborhoodInitiative — Community Goals

CatalogShop — Housing Store

Common Patterns

Check If Player Is Home

local function CheckHousingState()
    if HousingUI.IsPlayerInOwnHouse() then
        print("Welcome home!")
        local houseInfo = HousingUI.GetCurrentHouseInfo()
        if houseInfo then
            print("House:", houseInfo.name)
        end
    elseif HousingUI.IsPlayerInHouse() then
        local owner = HousingUI.GetHouseOwner()
        if owner then
            print("Visiting", owner.name, "'s house")
        end
    end
end

Place a Decoration

-- Enter housing edit mode and place an item
local function PlaceDecoration(catalogItemID)
    if not HousingUI.IsHousingModeActive() then
        HousingUI.EnterHousingMode()
    end
    
    local current, max = C_HouseEditorUI.GetPlacementLimits()
    if current >= max then
        print("Decoration limit reached:", current, "/", max)
        return
    end
    
    C_HouseEditorUI.PlaceObject(catalogItemID)
end

Browse Catalog

local function BrowseCatalog()
    local categories = C_HousingCatalog.GetCategories()
    for _, cat in ipairs(categories) do
        local catInfo = C_HousingCatalog.GetCategoryInfo(cat)
        if catInfo then
            print("Category:", catInfo.name)
            local items = C_HousingCatalog.GetItemsInCategory(cat)
            for _, item in ipairs(items) do
                local info = C_HousingCatalog.GetItemInfo(item)
                if info then
                    local owned = C_HousingCatalog.IsItemOwned(item)
                    print("  -", info.name, owned and "(Owned)" or "")
                end
            end
        end
    end
end

Save and Load Layouts

-- Save current decoration layout
HousingLayoutUI.SaveLayout("My Living Room v2")

-- List saved layouts
local layouts = HousingLayoutUI.GetSavedLayouts()
for _, layout in ipairs(layouts) do
    local info = HousingLayoutUI.GetLayoutInfo(layout)
    if info then
        print(info.name, "-", info.objectCount, "objects")
    end
end

Key Events

Gotchas & Restrictions

1. 12.0.0 only — The entire housing system is new in Patch 12.0.0. APIs may evolve in subsequent patches.
2. Mode requirements — Must call HousingUI.EnterHousingMode() before using editor functions.
3. Placement limits — Each house has a decoration cap. Check with GetPlacementLimits().
4. Expert vs Basic mode — Expert mode allows full 3D positioning; basic mode uses simplified snapping.
5. Own house only for editing — Cannot edit decorations in someone else's house.
6. Layout compatibility — Layouts may not load correctly if decorations have been removed from the game.
7. Neighborhood initiatives — Shared community goals; progress is collective, not individual.
8. Hardware events — Purchasing catalog items requires user interaction (hardware clicks).

Converted and distributed by TomeVault — claim your Tome and manage your conversions.