Talos docs

waterways

Since 0.6

Rivers, waterfalls and lakes from a terrain's hydrology, drawn and floated on, with per-id overrides.

Plain text

Roughness and flowScale change the water bodies feel; everything else is render only.

Use it in a scene entity's components list as { "type": "waterways", … }. The contract writes the fields flat and refuses unknown keys.

Fields

FieldTypeRequiredDefaultAllowed valuesDescription
terrainstringnoThe terrain entity. Absent: this entity if it is a terrain, else the scene's only terrain (waterways-without-terrain).
riversbooleannotrueDraw and float on the terrain's rivers. Default true; hide single ones with overrides[].hidden.
waterfallsbooleannotrueDraw and float on the terrain's waterfalls. Default true; hide single ones with overrides[].hidden.
lakesbooleannotrueDraw and float on the terrain's lakes. Default true; hide single ones with overrides[].hidden.
lookWaterwaysLooknoThe default look for all of them.
roughnessnumberno0Manning n of the river beds, 0.02..0.15. Default 0.045. Changes the speed, so it is part of a replay.
flowScalenumberno1Multiplies every river's speed, 0..4. Default 1; 0 is still water. Part of a replay.
foamnumberno1Scale on foam, 0..2. Default 1. Render only.
mistnumberno1Scale on waterfall mist, 0..2; 0 is none. Default 1. Render only.
overridesWaterwaysOverride[]noPer-id overrides, at most 64.

Rules that can refuse it