Taos API Reference
    Preparing search index...

    Interface TerrainDoc

    A CDLOD heightmap Terrain (see taos/terrain).

    interface TerrainDoc {
        type: "Terrain";
        quality?: "low" | "medium" | "high";
        heightScale?: number;
        worldExtent?: number;
        pagesPerSide?: number;
        bounded?: boolean;
        seed?: number;
        wireframe?: boolean;
        heightmap?: string;
        splatA?: string;
        splatB?: string;
        hole?: string;
        color?: string;
        autoshader?: boolean;
        regionsDir?: string;
        regionSize?: number;
        regionTexels?: number;
        regionRadius?: number;
        streamingRing?: number;
        treeShadowImpostors?: boolean;
        floorHeight?: number;
        layers?: TerrainLayerDoc[];
        collision?: boolean;
        collisionResolution?: number;
        grassEnabled?: boolean;
        grassLayerMask?: number;
        grassDensity?: number;
        grassHeight?: number;
        grassDistance?: number;
        treesEnabled?: boolean;
        treeLayerMask?: number;
        treeSpacing?: number;
        treeDistance?: number;
        treeMesh?: string;
    }
    Index

    Properties

    type quality? heightScale? worldExtent? pagesPerSide? bounded? seed? wireframe? heightmap? splatA? splatB? hole? color? autoshader? regionsDir? regionSize? regionTexels? regionRadius? streamingRing? treeShadowImpostors? floorHeight? layers? collision? collisionResolution? grassEnabled? grassLayerMask? grassDensity? grassHeight? grassDistance? treesEnabled? treeLayerMask? treeSpacing? treeDistance? treeMesh?

    Properties

    type: "Terrain"
    quality?: "low" | "medium" | "high"
    heightScale?: number

    Vertical height-map scale in world units.

    worldExtent?: number

    Square world extent in world units.

    pagesPerSide?: number

    Virtual pages per side.

    bounded?: boolean

    Keep every page resident (finite slab) instead of streaming.

    seed?: number

    World-generation seed.

    wireframe?: boolean

    Render as wireframe (debug).

    heightmap?: string

    Authored heightmap asset ref (raw LE uint16 .r16, or a grayscale image). Absent = procedural heights.

    splatA?: string

    Splat weight-map refs: RGBA of splatA weights layers 0-3, splatB layers 4-7. Absent = procedural height/slope splatting.

    splatB?: string
    hole?: string

    Hole mask asset ref (grayscale image; texel ≥ 50% = hole punched through render, shadows, picking and physics). Absent = no holes.

    color?: string

    Painted color/tint map asset ref (RGBA overlay; rgb centered at 0.5, a = paint opacity). Absent = no tinting.

    autoshader?: boolean

    Autoshader hybrid: unpainted splat texels fall back to the procedural height/slope rule instead of the base layer.

    regionsDir?: string

    Region streaming: Content-relative folder of sparse r{rx}_{rz}.r16 height tiles. Non-null replaces the single heightmap source.

    regionSize?: number

    World meters per region side.

    regionTexels?: number

    Interior sample cells per region side (tiles carry +1 samples).

    regionRadius?: number

    Region streaming ring radius.

    streamingRing?: number

    VT page streaming ring override (0 = engine default).

    treeShadowImpostors?: boolean

    Cast authored-tree shadows from the cone impostor instead of the full model (one cascade batch instead of one per primitive). Default true.

    floorHeight?: number

    World height outside the heightmap rect (sea level).

    layers?: TerrainLayerDoc[]

    Authored material layers (up to 8). Empty = the 4 procedural defaults.

    collision?: boolean

    Build a static physics heightfield from the authored heightmap.

    collisionResolution?: number

    Collider samples per side (power of two).

    grassEnabled?: boolean

    Grow the grass detail layer.

    grassLayerMask?: number

    Bit i set = splat layer i contributes grass density.

    grassDensity?: number

    Blades per square meter where the masked weight is 1.

    grassHeight?: number

    Mean blade height in meters.

    grassDistance?: number

    Blades draw out to this camera distance (meters).

    treesEnabled?: boolean

    Scatter the tree layer.

    treeLayerMask?: number

    Bit i set = splat layer i can grow trees.

    treeSpacing?: number

    Average spacing between trees in meters.

    treeDistance?: number

    Trees draw out to this camera distance (meters).

    treeMesh?: string

    Authored tree model asset ref (.glb/.gltf); absent = built-in pine.

    Settings

    Member Visibility

    On This Page

    Properties