@jgengine/core 0.9.0 → 0.11.0

package/dist/world/terrain.js

@@ -1,3 +1,5 @@
+import { withPathProfiles } from "./pathTerrain.js";
+import { nearestOnPath } from "./roads.js";
 function clamp01(value) {
     return value < 0 ? 0 : value > 1 ? 1 : value;
 }
@@ -13,6 +15,9 @@ function hash2(ix, iz, seed) {
     h ^= h >>> 12;
     return (h >>> 0) / 4294967295;
 }
+/** Smoothly interpolated 2D value noise in `[-1, 1]` for the given seed.
+ * @internal
+ */
 export function valueNoise(x, z, seed) {
     const x0 = Math.floor(x);
     const z0 = Math.floor(z);
@@ -28,6 +33,9 @@ export function valueNoise(x, z, seed) {
     const bottom = lerp(v01, v11, sx);
     return lerp(top, bottom, sz) * 2 - 1;
 }
+/** Layers `valueNoise` octaves per `config` into a single normalized noise sample.
+ * @internal
+ */
 export function fractalNoise(x, z, config) {
     let amplitude = 1;
     let frequency = config.frequency;
@@ -44,6 +52,7 @@ export function fractalNoise(x, z, config) {
     }
     return norm === 0 ? 0 : sum / norm;
 }
+/** @internal */
 export function seedFrom(value, fallback) {
     if (typeof value === "number")
         return value | 0;
@@ -57,6 +66,9 @@ export function seedFrom(value, fallback) {
     }
     return fallback;
 }
+/** Derives a `TerrainField.sampleNormal` from a height sampler via finite-difference gradients.
+ * @internal
+ */
 export function withNormal(sampleHeight) {
     const epsilon = 0.75;
     return (x, z) => {
@@ -81,9 +93,15 @@ export const FLAT_FIELD = {
     sampleHeight: () => 0,
     sampleNormal: () => [0, 1, 0],
 };
+/** A flat, zero-height `TerrainField` for arenas with no elevation.
+ * @internal
+ */
 export function flatField() {
     return FLAT_FIELD;
 }
+/** Builds a `TerrainField` whose height is fractal noise shaped by `config`.
+ * @internal
+ */
 export function noiseField(config = {}) {
     const fractal = {
         seed: seedFrom(config.seed, 1337),
@@ -100,6 +118,7 @@ export function noiseField(config = {}) {
         waterLevel: config.waterLevel,
     });
 }
+/** @internal */
 export function rollingField(config = {}) {
     return noiseField({
         seed: config.seed ?? "rolling",
@@ -120,6 +139,9 @@ function smoothstep(edge0, edge1, value) {
     const t = clamp01((value - edge0) / (edge1 - edge0));
     return t * t * (3 - 2 * t);
 }
+/** Builds a `TerrainField` with a flat spawn plateau, rolling hills, and a basin, for combat arenas.
+ * @internal
+ */
 export function arenaField(config = {}) {
     const seed = seedFrom(config.seed ?? "arena", 7);
     const rolling = {
@@ -148,11 +170,18 @@ export function arenaField(config = {}) {
     };
     return fieldFromHeight(sampleHeight, { bounds: config.bounds, waterLevel: ARENA_WATER_LEVEL });
 }
+/** @internal */
 export function groundFieldFor(world) {
     if (world !== undefined && world.kind === "environment")
         return resolveEnvironmentField(world);
     return flatField();
 }
+/** Whether a world declares real terrain (base heightfield or islands) rather than a flat plane — gates terrain-floor sampling in the movement controllers.
+ * @internal
+ */
+export function hasEnvironmentTerrain(world) {
+    return world?.kind === "environment" && (world.terrain !== undefined || (world.islands?.length ?? 0) > 0);
+}
 /** Ground height between islands when no base terrain exists — deep enough to read as a fall into the void, finite so physics stays sane. */
 export const ISLAND_VOID_HEIGHT = -256;
 function islandContains(descriptor, x, z) {
@@ -163,7 +192,8 @@ function islandContains(descriptor, x, z) {
  * Composes a base terrain and any number of bounded islands into one world field: inside an island's
  * rect the island's own field (sampled in island-local coordinates) wins, elsewhere the base terrain
  * answers, and with no base the gap is `ISLAND_VOID_HEIGHT` void. Later islands win overlaps.
- */
+  * @internal
+  */
 export function composeIslandFields(base, islands, voidHeight = ISLAND_VOID_HEIGHT) {
     if (islands.length === 0)
         return base ?? flatField();
@@ -198,14 +228,95 @@ export function composeIslandFields(base, islands, voidHeight = ISLAND_VOID_HEIG
         ...(base?.waterLevel === undefined ? {} : { waterLevel: base.waterLevel }),
     };
 }
-/** The full ground field for an environment world: base `terrain` composed with any `islands`. */
+/** Bilinear offset sampled from an editor {@link TerraformSnapshot}'s vertex grid at a world point. */
+function sampleSnapshotOffset(snapshot, x, z) {
+    const { bounds, cols, rows, offsets } = snapshot;
+    const vertsX = cols + 1;
+    const spanX = Math.max(bounds.maxX - bounds.minX, snapshot.cellSize);
+    const spanZ = Math.max(bounds.maxZ - bounds.minZ, snapshot.cellSize);
+    const fx = clamp01((x - bounds.minX) / spanX) * cols;
+    const fz = clamp01((z - bounds.minZ) / spanZ) * rows;
+    const x0 = Math.min(cols, Math.floor(fx));
+    const z0 = Math.min(rows, Math.floor(fz));
+    const x1 = Math.min(cols, x0 + 1);
+    const z1 = Math.min(rows, z0 + 1);
+    const tx = fx - x0;
+    const tz = fz - z0;
+    const v00 = offsets[z0 * vertsX + x0] ?? 0;
+    const v10 = offsets[z0 * vertsX + x1] ?? 0;
+    const v01 = offsets[z1 * vertsX + x0] ?? 0;
+    const v11 = offsets[z1 * vertsX + x1] ?? 0;
+    const top = v00 + (v10 - v00) * tx;
+    const bottom = v01 + (v11 - v01) * tx;
+    return top + (bottom - top) * tz;
+}
+/**
+ * Layers an authored sculpt snapshot's offsets over a base field — the editor-to-runtime ground seam.
+ * @internal — reached through `environment({ sculpt })`; not called directly by games.
+ */
+export function sculptedField(base, snapshot) {
+    const sampleHeight = (x, z) => base.sampleHeight(x, z) + sampleSnapshotOffset(snapshot, x, z);
+    return {
+        sampleHeight,
+        sampleNormal: withNormal(sampleHeight),
+        ...(base.bounds === undefined ? {} : { bounds: base.bounds }),
+        ...(base.waterLevel === undefined ? {} : { waterLevel: base.waterLevel }),
+    };
+}
+/**
+ * Levels a base field toward each clearance zone's center height within its radius (feathered) — so
+ * spawns, plots, and paths sit on flat ground even when a mound is nearby. The strongest overlapping
+ * zone wins. Pairs with scatter's avoid: one clearance zone both flattens ground and repels foliage.
+ * @internal — reached through `environment({ clearings })`; not called directly by games.
+ */
+export function flattenFieldAround(base, zones) {
+    if (zones.length === 0)
+        return base;
+    const sampleHeight = (x, z) => {
+        let best = 0;
+        let target = 0;
+        for (const zone of zones) {
+            const dist = Math.hypot(x - zone.x, z - zone.z);
+            if (dist >= zone.radius)
+                continue;
+            const feather = Math.max(0, zone.feather ?? 0);
+            const inner = zone.radius - feather;
+            const t = dist <= inner || feather <= 0 ? 1 : (zone.radius - dist) / feather;
+            if (t > best) {
+                best = t;
+                target = base.sampleHeight(zone.x, zone.z);
+            }
+        }
+        const height = base.sampleHeight(x, z);
+        return best > 0 ? height + (target - height) * best : height;
+    };
+    return {
+        sampleHeight,
+        sampleNormal: withNormal(sampleHeight),
+        ...(base.bounds === undefined ? {} : { bounds: base.bounds }),
+        ...(base.waterLevel === undefined ? {} : { waterLevel: base.waterLevel }),
+    };
+}
+/**
+ * The full ground field for an environment world: base `terrain` composed with any `islands`, then
+ * any authored `sculpt` snapshot, then any `clearings` flattened on top — so an editor-sculpted
+ * heightfield drives both the rendered mesh and player collision, and gameplay spots stay level,
+ * through the one seam every consumer already reads.
+  * @internal
+  */
 export function resolveEnvironmentField(feature) {
     const base = feature.terrain === undefined ? null : resolveTerrainField(feature.terrain);
-    if (feature.islands === undefined || feature.islands.length === 0)
-        return base ?? flatField();
-    return composeIslandFields(base, feature.islands);
+    const composed = feature.islands === undefined || feature.islands.length === 0
+        ? base ?? flatField()
+        : composeIslandFields(base, feature.islands);
+    const sculpted = feature.sculpt === undefined ? composed : sculptedField(composed, feature.sculpt);
+    return feature.clearings === undefined || feature.clearings.length === 0
+        ? sculpted
+        : flattenFieldAround(sculpted, feature.clearings);
 }
-/** Local slope from the field's normal — the input for gravity-roll, ski acceleration, and slide checks (#284.6). */
+/** Local slope from the field's normal — the input for gravity-roll, ski acceleration, and slide checks (#284.6).
+ * @internal
+ */
 export function sampleSlope(field, x, z) {
     const [nx, ny, nz] = field.sampleNormal(x, z);
     const horizontal = Math.hypot(nx, nz);
@@ -219,7 +330,8 @@ export function sampleSlope(field, x, z) {
 /**
  * Downhill force/acceleration from the local slope: direction × sin(slope angle) × `scale`.
  * Add it to any integrator's XZ velocity each tick (`scale` ≈ gravity for a free-rolling body).
- */
+  * @internal
+  */
 export function slopeForce(field, x, z, scale = 9.8) {
     const [nx, , nz] = field.sampleNormal(x, z);
     if (Math.hypot(nx, nz) < 1e-9)
@@ -236,6 +348,46 @@ export const TERRAIN_MATERIAL_PALETTES = {
     highland: { low: "#414f33", high: "#a3a86b", waterline: "#365f63" },
     slate: { low: "#2f3540", high: "#7d8896", waterline: "#26404f" },
 };
+const DEFAULT_TERRAIN_DETAIL = {
+    rockColor: "#6f7175",
+    sandColor: "#c2b283",
+    snowColor: "#eef3f7",
+    rockSlopeStart: 0.42,
+    snowHeight: 26,
+    detailScale: 5,
+    macroScale: 45,
+    roughness: 0.9,
+    strength: 1,
+};
+const DEFAULT_TERRAIN_MATERIAL_REPEAT = 4;
+const DEFAULT_TERRAIN_MATERIAL_STRENGTH = 1;
+/** Fill a `TerrainDetailConfig` with defaults; `waterLevel` falls back to the terrain's own water level.
+ * @internal
+ */
+export function resolveTerrainDetail(config, terrainWaterLevel = 0) {
+    return {
+        rockColor: config.rockColor ?? DEFAULT_TERRAIN_DETAIL.rockColor,
+        sandColor: config.sandColor ?? DEFAULT_TERRAIN_DETAIL.sandColor,
+        snowColor: config.snowColor ?? DEFAULT_TERRAIN_DETAIL.snowColor,
+        rockSlopeStart: config.rockSlopeStart ?? DEFAULT_TERRAIN_DETAIL.rockSlopeStart,
+        snowHeight: config.snowHeight ?? DEFAULT_TERRAIN_DETAIL.snowHeight,
+        detailScale: config.detailScale ?? DEFAULT_TERRAIN_DETAIL.detailScale,
+        macroScale: config.macroScale ?? DEFAULT_TERRAIN_DETAIL.macroScale,
+        roughness: config.roughness ?? DEFAULT_TERRAIN_DETAIL.roughness,
+        strength: clamp01(config.strength ?? DEFAULT_TERRAIN_DETAIL.strength),
+        waterLevel: config.waterLevel ?? terrainWaterLevel,
+        ...(config.material === undefined
+            ? {}
+            : {
+                material: {
+                    maps: config.material.maps,
+                    repeat: config.material.repeat ?? DEFAULT_TERRAIN_MATERIAL_REPEAT,
+                    strength: clamp01(config.material.strength ?? DEFAULT_TERRAIN_MATERIAL_STRENGTH),
+                },
+            }),
+    };
+}
+/** @internal */
 export function resolveTerrainPalette(descriptor = {}) {
     const material = descriptor.material ?? DEFAULT_TERRAIN_MATERIAL;
     const preset = TERRAIN_MATERIAL_PALETTES[material];
@@ -277,36 +429,170 @@ function mixPalette(from, to, t) {
         waterline: mixHex(from.waterline, to.waterline, t),
     };
 }
+function createBandValueSampler(bands, fallback, resolve, mix) {
+    if (bands.length === 0)
+        return () => fallback;
+    const resolved = bands
+        .map((band) => ({ z: band.z, fade: band.fade ?? 64, value: resolve(band) }))
+        .sort((a, b) => a.z - b.z);
+    const first = resolved[0];
+    const last = resolved[resolved.length - 1];
+    return (z) => {
+        if (z <= first.z)
+            return first.value;
+        if (z >= last.z)
+            return last.value;
+        for (let i = 0; i < resolved.length - 1; i += 1) {
+            const lower = resolved[i];
+            const upper = resolved[i + 1];
+            if (z < lower.z || z > upper.z)
+                continue;
+            const boundary = (lower.z + upper.z) / 2;
+            const half = Math.min(lower.fade, upper.fade) / 2;
+            if (z <= boundary - half)
+                return lower.value;
+            if (z >= boundary + half)
+                return upper.value;
+            return mix(lower.value, upper.value, smoothstep(boundary - half, boundary + half, z));
+        }
+        return fallback;
+    };
+}
 /**
- * Per-position palette sampler over the descriptor's base `material`/`colors` plus its
- * `materialRegions` — the multi-biome coloring seam. Regions paint fully inside `radius`
- * and blend back to the surrounding palette across `falloff`; later regions win overlaps.
- */
+ * Per-z palette sampler over a descriptor's `biomeBands` — ordered zones that cross-fade their
+ * ground palette across a `fade`-wide window centered on the midpoint z between adjacent centers.
+ * Below the first / above the last band clamps to that band's palette. Returns `fallback` when no
+ * bands are declared. Pure math, unit-testable independent of rendering.
+  * @internal
+  */
+export function createBiomeBandSampler(bands, fallback) {
+    return createBandValueSampler(bands, fallback, resolveTerrainPalette, mixPalette);
+}
+function mixBiomeFog(from, to, t) {
+    if (t <= 0)
+        return from;
+    if (t >= 1)
+        return to;
+    return {
+        color: mixHex(from.color, to.color, t),
+        near: lerp(from.near, to.near, t),
+        far: lerp(from.far, to.far, t),
+        density: lerp(from.density, to.density, t),
+    };
+}
+/**
+ * Per-z fog sampler over a descriptor's `biomeBands` — cross-fades each band's `fog` (unset fields
+ * falling through to `fallback`) across the same `fade` window as the ground sampler, so fog color and
+ * range track the camera's z. Bands with no `fog` resolve to `fallback`. Pure math, unit-testable.
+  * @internal
+  */
+export function createBiomeFogSampler(bands, fallback) {
+    return createBandValueSampler(bands, fallback, (band) => band.fog === undefined
+        ? fallback
+        : {
+            color: band.fog.color ?? fallback.color,
+            near: band.fog.near ?? fallback.near,
+            far: band.fog.far ?? fallback.far,
+            density: band.fog.density ?? fallback.density,
+        }, mixBiomeFog);
+}
+function mixBiomeSky(from, to, t) {
+    if (t <= 0)
+        return from;
+    if (t >= 1)
+        return to;
+    return {
+        horizonColor: mixHex(from.horizonColor, to.horizonColor, t),
+        zenithColor: mixHex(from.zenithColor, to.zenithColor, t),
+        sunIntensity: lerp(from.sunIntensity, to.sunIntensity, t),
+        ambientIntensity: lerp(from.ambientIntensity, to.ambientIntensity, t),
+    };
+}
+/**
+ * Per-z sky sampler over a descriptor's `biomeBands` — cross-fades each band's `sky` (unset fields
+ * falling through to `fallback`) across the same `fade` window as the ground sampler, so horizon/zenith
+ * colors and sun/ambient intensity track the camera's z. Bands with no `sky` resolve to `fallback`.
+  * @internal
+  */
+export function createBiomeSkySampler(bands, fallback) {
+    return createBandValueSampler(bands, fallback, (band) => band.sky === undefined
+        ? fallback
+        : {
+            horizonColor: band.sky.horizonColor ?? fallback.horizonColor,
+            zenithColor: band.sky.zenithColor ?? fallback.zenithColor,
+            sunIntensity: band.sky.sunIntensity ?? fallback.sunIntensity,
+            ambientIntensity: band.sky.ambientIntensity ?? fallback.ambientIntensity,
+        }, mixBiomeSky);
+}
+/**
+ * Per-position palette sampler over the descriptor's base `material`/`colors` plus its z-ordered
+ * `biomeBands` (painted first) and radial `materialRegions` (painted over) — the multi-biome coloring
+ * seam. Regions paint fully inside `radius` and blend back across `falloff`; later regions win overlaps.
+  * @internal
+  */
 export function createTerrainPaletteSampler(descriptor) {
     const base = resolveTerrainPalette(descriptor);
+    const bandSampler = descriptor.biomeBands === undefined || descriptor.biomeBands.length === 0
+        ? null
+        : createBiomeBandSampler(descriptor.biomeBands, base);
     const regions = (descriptor.materialRegions ?? []).map((region) => ({
-        center: region.center,
-        radius: region.radius,
-        falloff: region.falloff ?? region.radius * 0.5,
+        ...resolveRegionShape(region),
         palette: resolveTerrainPalette(region),
     }));
-    if (regions.length === 0)
+    if (regions.length === 0 && bandSampler === null)
         return () => base;
     return (x, z) => {
-        let palette = base;
+        let palette = bandSampler === null ? base : bandSampler(z);
         for (const region of regions) {
-            const distance = Math.hypot(x - region.center[0], z - region.center[1]);
-            if (distance <= region.radius) {
+            const distance = region.coreDistance(x, z);
+            if (distance <= 0) {
                 palette = region.palette;
             }
-            else if (distance <= region.radius + region.falloff) {
-                const t = smoothstep(region.radius, region.radius + region.falloff, distance);
+            else if (distance <= region.falloff) {
+                const t = smoothstep(0, region.falloff, distance);
                 palette = mixPalette(region.palette, palette, t);
             }
         }
         return palette;
     };
 }
+/**
+ * Resolves a `TerrainMaterialRegion` of any shape to a `coreDistance(x, z)` — 0 inside the painted
+ * core, growing positive outward — plus its blend-ring `falloff`, so the palette sampler blends every
+ * shape through one shape-agnostic loop.
+ */
+function resolveRegionShape(region) {
+    if (region.shape === "polyline") {
+        const half = region.width * 0.5;
+        return {
+            falloff: region.falloff ?? half,
+            coreDistance: (x, z) => {
+                const sample = nearestOnPath(region.points, x, z);
+                return sample === null ? Number.POSITIVE_INFINITY : Math.max(0, sample.distance - half);
+            },
+        };
+    }
+    if (region.shape === "rect") {
+        const [hx, hz] = region.halfExtents;
+        const angle = region.rotationY ?? 0;
+        const cos = Math.cos(angle);
+        const sin = Math.sin(angle);
+        return {
+            falloff: region.falloff ?? Math.min(hx, hz) * 0.5,
+            coreDistance: (x, z) => {
+                const dx = x - region.center[0];
+                const dz = z - region.center[1];
+                const lx = dx * cos + dz * sin;
+                const lz = -dx * sin + dz * cos;
+                return Math.hypot(Math.max(0, Math.abs(lx) - hx), Math.max(0, Math.abs(lz) - hz));
+            },
+        };
+    }
+    return {
+        falloff: region.falloff ?? region.radius * 0.5,
+        coreDistance: (x, z) => Math.max(0, Math.hypot(x - region.center[0], z - region.center[1]) - region.radius),
+    };
+}
 function withFlattenMasks(sampleHeight, masks) {
     const resolved = masks.map((mask) => ({
         center: mask.center,
@@ -330,6 +616,7 @@ function withFlattenMasks(sampleHeight, masks) {
         return height;
     };
 }
+/** @internal */
 export function heightMapField(config) {
     const { columns, rows, samples } = config;
     if (columns <= 0 || rows <= 0)
@@ -366,6 +653,9 @@ export function heightMapField(config) {
         ...(config.waterLevel === undefined ? {} : { waterLevel: config.waterLevel }),
     });
 }
+/** Resolves a `TerrainEnvironmentDescriptor` into a concrete `TerrainField`, applying flatten masks.
+ * @internal
+ */
 export function resolveTerrainField(descriptor) {
     if (descriptor === undefined)
         return flatField();
@@ -387,19 +677,44 @@ export function resolveTerrainField(descriptor) {
             waterLevel: descriptor.waterLevel,
             bounds: descriptor.bounds,
         });
-    if (descriptor.flatten === undefined || descriptor.flatten.length === 0)
-        return base;
-    return fieldFromHeight(withFlattenMasks(base.sampleHeight, descriptor.flatten), {
-        bounds: base.bounds,
-        waterLevel: base.waterLevel,
-    });
+    const flattened = descriptor.flatten === undefined || descriptor.flatten.length === 0
+        ? base
+        : fieldFromHeight(withFlattenMasks(base.sampleHeight, descriptor.flatten), {
+            bounds: base.bounds,
+            waterLevel: base.waterLevel,
+        });
+    if (descriptor.pathProfiles === undefined || descriptor.pathProfiles.length === 0)
+        return flattened;
+    return applyPathProfiles(flattened, descriptor.pathProfiles);
 }
-/** Returns `position` with `y` replaced by the field's ground height (plus `offset`) at its `x`/`z`. */
+/**
+ * Composes authored path profiles onto a field — the shared seam that turns a scene road/river/ramp path
+ * into flattened, graded, carved, or retained ground. Applies after `flatten` masks in `resolveTerrainField`
+ * so a corridor grades over already-leveled pads; call it directly to layer profiles onto any field a game
+ * builds by hand. Returns the field unchanged when no profile is given.
+ * @capability path-terrain apply flatten/grade/carve/retaining path profiles to a terrain field
+ */
+export function applyPathProfiles(field, profiles) {
+    if (profiles.length === 0)
+        return field;
+    const sampleHeight = withPathProfiles((x, z) => field.sampleHeight(x, z), profiles);
+    return {
+        sampleHeight,
+        sampleNormal: withNormal(sampleHeight),
+        ...(field.bounds === undefined ? {} : { bounds: field.bounds }),
+        ...(field.waterLevel === undefined ? {} : { waterLevel: field.waterLevel }),
+    };
+}
+/** Returns `position` with `y` replaced by the field's ground height (plus `offset`) at its `x`/`z`.
+ * @internal
+ */
 export function snapToGround(field, position, offset = 0) {
     const [x, , z] = position;
     return [x, field.sampleHeight(x, z) + offset, z];
 }
-/** Ground-snaps an already-spawned entity in place; returns false when `id` is unknown. */
+/** Ground-snaps an already-spawned entity in place; returns false when `id` is unknown.
+ * @internal
+ */
 export function snapEntityToGround(entities, id, field, offset = 0) {
     const entity = entities.get(id);
     if (entity === null)
@@ -407,6 +722,9 @@ export function snapEntityToGround(entities, id, field, offset = 0) {
     return entities.setPose(id, { position: snapToGround(field, entity.position, offset) });
 }
 export const DEFAULT_MAX_WALK_SLOPE = 0.6;
+/** Zeroes out a movement step's x or z component where it would climb steeper than `maxSlope`.
+ * @internal
+ */
 export function resolveGroundStep(field, x, z, stepX, stepZ, maxSlope = DEFAULT_MAX_WALK_SLOPE) {
     const baseHeight = field.sampleHeight(x, z);
     const tooSteep = (dx, dz) => {