Console Commands¶
HausTools adds a set of editor console commands. Normal work never needs them. They are for when something looks wrong and you want a fact. Like the rest of the plugin they exist in the editor only.
Open the console with the backtick key (`) in the editor viewport, or use
the Cmd box at the bottom of the Output Log (Window → Output Log). Type
HausTools. and the console lists them.
Baking and rebuilding¶
| Command | What it does |
|---|---|
HausTools.BakeWindow |
Opens the Bake window, like the toolbar's Bake button |
HausTools.Bake |
Bakes every plot in the map with the current Bake settings. The Bake window bakes only the buildings you tick |
HausTools.Rebuild |
Rebuilds every plot. An edit rebuilds by itself, so this is for forcing one, for example after updating the plugin |
Authoring a pack¶
| Command | What it does |
|---|---|
HausTools.ScanKit <ContentRoot> [CellSizeCm=100] |
Lists every static mesh under a content path with its size in grid cells and in centimetres. The centimetres show which meshes are 290 cm where they should be 3 m |
HausTools.DumpKit [KitAsset] |
Logs the bounds of every piece in the pack: min, max and size. The first thing to check when a piece tiles with a gap |
HausTools.BakePivots [KitAsset] [force] |
Measures the pack's meshes and stores how each one sits. HausTools does this by itself for a new piece. force measures every piece again, which resets its Pivot and keeps Rotation and Length axis |
HausTools.DiagnoseKit [groupIndex=0] |
Builds a test building named HT_KitDiagnosis in the level, clad from the pack: a corner, a straight run and a 45° run with a window. It writes every size, pivot, placement and joint to Saved/HT_KitDiagnosis.txt, and replaces the building of the run before |
HausTools.DiagnoseWallJoints |
Measures every clad wall run on the selected plots, or on all of them, and lists the seams that are not flush in Saved/HT_WallJoints.txt. It changes nothing |
HausTools.DiagnoseGutters |
Builds two test buildings with gutters, a gable and an L-shaped hip, and writes each gutter piece's placement and joint gap to Saved/HT_GutterDiagnosis.txt |
HausTools.ExportTrimReference [-HighPoly] [OutPath] |
Exports the trim-sheet reference mesh as an OBJ, to Saved/HT_TrimReference.obj unless you give a path |
HausTools.ExportDeckKit [OutDir] |
Exports the deck skirt templates, straight and corner, as OBJ files built from the real deck geometry. They go to KitTemplates/Deck in the project unless you give a folder |
See Building Your Own Pack for what the numbers mean.
Explaining a result¶
Each of these writes its answer to the Output Log.
| Command | What it does |
|---|---|
HausTools.RoofWhy <x> <y> |
Explains the roof at one position on the plan, given in centimetres: how high each roof stands there and which one won. Use it when a roof has a hole you did not expect |
HausTools.DebugRoofs |
Logs the roof build for every plot: its roofs, the clusters overlapping roofs formed and what each cluster produced. It also exports the result as OBJ files to Saved/HausTools/RoofDebug |
HausTools.DebugShaftWalls |
Logs how the walls around each stairwell were worked out, edge by edge |
HausTools.DebugShaftTrim 1 |
Logs how each staircase trim run was laid out, on every rebuild until you set it back to 0 |
HausTools.DumpShell |
Exports every plot's shell as an OBJ file to Saved/HausTools/ShellDebug. It exports what is built now, so run HausTools.Rebuild first if you have just updated the plugin |
HausTools.BakeAudit [ContentPath] |
Checks every baked mesh for what Lumen needs: a distance field, surface-cache cards and triangles to trace. It lists the meshes that fail and ends with a count. It checks the bake output folder unless you give a content path. See Lighting |
HausTools.RebuildPerf [Iters=3] [flush] |
Rebuilds every plot three times and logs how long each phase took. flush clears the roof caches before each pass, which times a roof edit. HausTools.RebuildPerf trace [N=1] times the next edit you make instead, or the next N |
Viewport overlays¶
These draw in the viewport, in HausTools mode only, and stay on until you turn
them off. The collision and roof overlays are captured during a rebuild, so
make an edit or run HausTools.Rebuild after switching one on.
| Command | What it does |
|---|---|
HausTools.ShowCollision |
Draws the collision a bake installs as a wireframe, one colour per blocker and named up close. Run it again to turn it off. Pack pieces keep the collision of their own mesh and are not drawn. See What blocks |
HausTools.DebugPlacement 1 |
Labels every placed pack piece with its mesh name and every wall run with its length. 0 turns it off. The placement debug button () in the catalog's STYLES header does the same |
HausTools.RoofViz all |
Draws every layer of the roof overlay. A layer name in place of all switches that one layer on or off: runs, soffit, surface, ridge, gable, cuts, boxes, closures, carves, overhang or collision. labels does the same for the text and off clears everything. With nothing after it the command logs which layers are on and the colour of each |
Reporting a problem¶
Describe what went wrong on the PropHaus Discord, the quickest way to reach us. Email to mcatena@marcocatena.com works too. Include your HausTools version, listed under Edit → Plugins, and your Unreal version.
If the problem is hard to describe, attach either of these:
- The project's log file, from
Saved/Logsin your project folder. - The output of the command that matches the problem:
HausTools.DiagnoseKitfor pack pieces that sit wrong,HausTools.DebugRoofsfor a roof orHausTools.DumpShellfor walls and floors.