Header menu logo Mibo

Interior Module

A domain module providing standard layout stamps for interior 3D spaces. These functions generate enclosed geometry like rooms, corridors, and architectural elements. They are agnostic to content type, allowing flexible reuse.

Types

Type Description

DoorSide

Side of a room for doorway/window placement.

Functions and values

Function or value Description

corridorX length width height floor wall ceiling section

Full Usage: corridorX length width height floor wall ceiling section

Parameters:
    length : int - Length of the corridor (X axis).
    width : int - Width of the corridor (Z axis).
    height : int - Height of the corridor (Y axis).
    floor : 'T
    wall : 'T
    ceiling : 'T
    section : GridSection3D<'T>

Returns: GridSection3D<'T>
Modifiers: inline
Type parameters: 'T

Generates a horizontal corridor along the X axis (open at both X ends).

length : int

Length of the corridor (X axis).

width : int

Width of the corridor (Z axis).

height : int

Height of the corridor (Y axis).

floor : 'T
wall : 'T
ceiling : 'T
section : GridSection3D<'T>
Returns: GridSection3D<'T>

corridorZ length width height floor wall ceiling section

Full Usage: corridorZ length width height floor wall ceiling section

Parameters:
    length : int
    width : int
    height : int
    floor : 'T
    wall : 'T
    ceiling : 'T
    section : GridSection3D<'T>

Returns: GridSection3D<'T>
Modifiers: inline
Type parameters: 'T

Generates a corridor along the Z axis (open at both Z ends).

length : int
width : int
height : int
floor : 'T
wall : 'T
ceiling : 'T
section : GridSection3D<'T>
Returns: GridSection3D<'T>

doorway side doorWidth doorHeight section

Full Usage: doorway side doorWidth doorHeight section

Parameters:
    side : DoorSide - Which wall to cut the doorway in.
    doorWidth : int - Width of the door opening.
    doorHeight : int - Height of the door opening.
    section : GridSection3D<'T>

Returns: GridSection3D<'T>
Modifiers: inline
Type parameters: 'T

Clears a doorway opening in a wall. Position the section at the doorway location.

side : DoorSide

Which wall to cut the doorway in.

doorWidth : int

Width of the door opening.

doorHeight : int

Height of the door opening.

section : GridSection3D<'T>
Returns: GridSection3D<'T>

openRoom width height depth floor wall section

Full Usage: openRoom width height depth floor wall section

Parameters:
    width : int
    height : int
    depth : int
    floor : 'T
    wall : 'T
    section : GridSection3D<'T>

Returns: GridSection3D<'T>
Modifiers: inline
Type parameters: 'T

Generates a room with floor and walls but no ceiling (open-top).

width : int
height : int
depth : int
floor : 'T
wall : 'T
section : GridSection3D<'T>
Returns: GridSection3D<'T>

pillar height baseTile middleTile topTile section

Full Usage: pillar height baseTile middleTile topTile section

Parameters:
    height : int
    baseTile : 'T
    middleTile : 'T
    topTile : 'T
    section : GridSection3D<'T>

Returns: GridSection3D<'T>
Modifiers: inline
Type parameters: 'T

Generates a vertical pillar/column with distinct base, middle, and top.

height : int
baseTile : 'T
middleTile : 'T
topTile : 'T
section : GridSection3D<'T>
Returns: GridSection3D<'T>

room width height depth floor wall ceiling section

Full Usage: room width height depth floor wall ceiling section

Parameters:
    width : int - Width of the room (X axis).
    height : int - Height of the room (Y axis).
    depth : int - Depth of the room (Z axis).
    floor : 'T - Content for the floor.
    wall : 'T - Content for the walls.
    ceiling : 'T - Content for the ceiling.
    section : GridSection3D<'T>

Returns: GridSection3D<'T>
Modifiers: inline
Type parameters: 'T

Generates an enclosed room with floor, walls, and ceiling.

width : int

Width of the room (X axis).

height : int

Height of the room (Y axis).

depth : int

Depth of the room (Z axis).

floor : 'T

Content for the floor.

wall : 'T

Content for the walls.

ceiling : 'T

Content for the ceiling.

section : GridSection3D<'T>
Returns: GridSection3D<'T>

scatterEdges count seed content section

Full Usage: scatterEdges count seed content section

Parameters:
    count : int
    seed : int
    content : 'T
    section : GridSection3D<'T>

Returns: GridSection3D<'T>
Modifiers: inline
Type parameters: 'T

Scatters content along all room edges/corners.

count : int
seed : int
content : 'T
section : GridSection3D<'T>
Returns: GridSection3D<'T>

scatterWall side count seed content section

Full Usage: scatterWall side count seed content section

Parameters:
Returns: GridSection3D<'T>
Modifiers: inline
Type parameters: 'T

Scatters content randomly on a specific wall/side of the current section.

side : DoorSide
count : int
seed : int
content : 'T
section : GridSection3D<'T>
Returns: GridSection3D<'T>

shaft width depth height wall section

Full Usage: shaft width depth height wall section

Parameters:
    width : int
    depth : int
    height : int
    wall : 'T
    section : GridSection3D<'T>

Returns: GridSection3D<'T>
Modifiers: inline
Type parameters: 'T

Generates a vertical shaft (elevator space, ladder well). Creates walls with hollow interior.

width : int
depth : int
height : int
wall : 'T
section : GridSection3D<'T>
Returns: GridSection3D<'T>

stairs width rise run step section

Full Usage: stairs width rise run step section

Parameters:
    width : int - Width of the stairs (X axis).
    rise : int - Total height to climb (number of Y levels).
    run : int - Total run/depth of stairs (Z axis).
    step : 'T - Content for each step.
    section : GridSection3D<'T>

Returns: GridSection3D<'T>
Modifiers: inline
Type parameters: 'T

Generates a staircase with individual steps.

width : int

Width of the stairs (X axis).

rise : int

Total height to climb (number of Y levels).

run : int

Total run/depth of stairs (Z axis).

step : 'T

Content for each step.

section : GridSection3D<'T>
Returns: GridSection3D<'T>

weather oldContent newContent probability seed section

Full Usage: weather oldContent newContent probability seed section

Parameters:
    oldContent : 'T
    newContent : 'T
    probability : float32
    seed : int
    section : GridSection3D<'T>

Returns: GridSection3D<'T>
Modifiers: inline
Type parameters: 'T

Non-destructively decorates existing surfaces by replacing a percentage of tiles.

oldContent : 'T
newContent : 'T
probability : float32
seed : int
section : GridSection3D<'T>
Returns: GridSection3D<'T>

window side windowWidth windowHeight sillHeight section

Full Usage: window side windowWidth windowHeight sillHeight section

Parameters:
    side : DoorSide - Which wall to cut the window in.
    windowWidth : int - Width of the window.
    windowHeight : int - Height of the window.
    sillHeight : int - Height from floor to bottom of window.
    section : GridSection3D<'T>

Returns: GridSection3D<'T>
Modifiers: inline
Type parameters: 'T

Clears a window opening in a wall.

side : DoorSide

Which wall to cut the window in.

windowWidth : int

Width of the window.

windowHeight : int

Height of the window.

sillHeight : int

Height from floor to bottom of window.

section : GridSection3D<'T>
Returns: GridSection3D<'T>

Type something to start searching.