Log inGet started
Package

StreamWater.module

This package holds more than this page lists. See all of its files in its world.

README.md

StreamWater

The forest stream's flowing water surface: a ribbon mesh built with renderer.mesh.create that follows the Ground site's stream centreline and its falling water level, textured with ForestMaterials.get("water") (Flux and Flicker's clear river, flow mapped so the U axis runs downstream in metres).

local StreamWater = require("~.StreamWater")
local water = StreamWater.build(site)   -- an entity carrying the ribbon mesh and material
water:destroy()

Called by ForestBuilder.build when opts.stream is true; returned as forest.water. Not used when a forest has no stream.