smooth(e0: number, e1: number, x: number) → number
| arg | type | description |
|---|
| e0 | number | |
| e1 | number | |
| x | number | |
rng(seed: number) → void
A small deterministic random stream (LCG) so placement never depends on math.random's state.
| arg | type | description |
|---|
| seed | number | |
fbm(x: number, z: number, seed: number, octaves: number) → number
| arg | type | description |
|---|
| x | number | |
| z | number | |
| seed | number | |
| octaves | number | |
buildField(points: { Point }, x0: number, z0: number, size: number, cell: number, reach: number) → Field
| arg | type | description |
|---|
| points | { Point } | |
| x0 | number | |
| z0 | number | |
| size | number | |
| cell | number | |
| reach | number | |
sampleField(f: Field, x: number, z: number) → void
| arg | type | description |
|---|
| f | Field | |
| x | number | |
| z | number | |
polyLength(points: { Point }) → number
| arg | type | description |
|---|
| points | { Point } | |
polyDistance(points: { Point }, x: number, z: number) → number
Exact distance to a polyline (for queries outside a field's reach).
| arg | type | description |
|---|
| points | { Point } | |
| x | number | |
| z | number | |
baseHeight(self: Site, x: number, z: number) → number
The land before the stream is cut into it.
| arg | type | description |
|---|
| self | Site | |
| x | number | |
| z | number | |
makeStream(self: Site) → void
| arg | type | description |
|---|
| self | Site | |
levelAt(self: Site, a: number) → number
The stream's water level at a distance along it.
| arg | type | description |
|---|
| self | Site | |
| a | number | |
stream(self: Site, x: number, z: number) → void
Metres to the stream's centreline, and its water level nearest the point.
Beyond the valley the distance is exact but slower; math.huge with no stream.
| arg | type | description |
|---|
| self | Site | |
| x | number | |
| z | number | |
pathDistance(self: Site, x: number, z: number) → number
| arg | type | description |
|---|
| self | Site | |
| x | number | |
| z | number | |
flatBlend(f: Flat, x: number, z: number) → number
0 inside a level pad's rectangle, easing to 1 at `blend` metres outside it.
| arg | type | description |
|---|
| f | Flat | |
| x | number | |
| z | number | |
clearing(self: Site, x: number, z: number) → number
0 outside every clearing, 1 in the open middle of one.
| arg | type | description |
|---|
| self | Site | |
| x | number | |
| z | number | |
height(self: Site, x: number, z: number) → number
| arg | type | description |
|---|
| self | Site | |
| x | number | |
| z | number | |
water(self: Site, x: number, z: number) → number
The water surface over a point, or nil where it is dry.
| arg | type | description |
|---|
| self | Site | |
| x | number | |
| z | number | |
surface(self: Site, x: number, z: number) → string
| arg | type | description |
|---|
| self | Site | |
| x | number | |
| z | number | |
footSurface(self: Site, x: number, z: number) → string
| arg | type | description |
|---|
| self | Site | |
| x | number | |
| z | number | |
inside(self: Site, x: number, z: number, margin: number?) → boolean
| arg | type | description |
|---|
| self | Site | |
| x | number | |
| z | number | |
| margin | number? | |
site(opts: SiteOpts) → Site
| arg | type | description |
|---|
| opts | SiteOpts | |
setActive(site: Site?) → void
| arg | type | description |
|---|
| site | Site? | |
surfaceAt(x: number, z: number) → string
The footstep surface at a point of the active forest: leaves, moss, mud, path, grass or water.
| arg | type | description |
|---|
| x | number | |
| z | number | |
streamDistance(x: number, z: number) → number
Metres from a point to the active forest's stream centreline (math.huge when it has none).
| arg | type | description |
|---|
| x | number | |
| z | number | |
heightAt(x: number, z: number) → number
Ground height of the active forest at a point (0 when no forest is active).
| arg | type | description |
|---|
| x | number | |
| z | number | |
groundTexture(name: string) → string
| arg | type | description |
|---|
| name | string | |
layers( ) → void
The layer table a TerrainStream source takes: every forest layer painted with Terra Firma's maps (a tint alone where they are missing).
sampleCache(key: string) → any
| arg | type | description |
|---|
| key | string | |
terrainSource(site: Site, key: string?) → void
| arg | type | description |
|---|
| site | Site | |
| key | string? | |
height(x: number, z: number) → void
| arg | type | description |
|---|
| x | number | |
| z | number | |
layer(x: number, z: number) → void
| arg | type | description |
|---|
| x | number | |
| z | number | |
cell(x: number, z: number) → number
quarter-metre cells: a stream samples on whole multiples of its resolution
| arg | type | description |
|---|
| x | number | |
| z | number | |
height(x: number, z: number) → void
| arg | type | description |
|---|
| x | number | |
| z | number | |
layer(x: number, z: number) → void
| arg | type | description |
|---|
| x | number | |
| z | number | |