sstep(y: number) → number
| arg | type | description |
|---|
| y | number | |
norm(x: number, z: number) → void
| arg | type | description |
|---|
| x | number | |
| z | number | |
shapeFor(kind: string?, dunes: string?) → string
The dune shape a kind uses when `dunes` is "auto".
| arg | type | description |
|---|
| kind | string? | |
| dunes | string? | |
spline(ctrl: { { number } }, step: number) → void
Catmull-Rom through control points, every `step` metres (exact arithmetic only).
| arg | type | description |
|---|
| ctrl | { { number } } | |
| step | number | |
new(opts: Opts) → void
| arg | type | description |
|---|
| opts | Opts | |
at(along: number, lateral: number) → void
| arg | type | description |
|---|
| along | number | |
| lateral | number | |
jit(k: number) → number return
| arg | type | description |
|---|
| k | number | |
pathDist(self: any, x: number, z: number) → number
Metres from a point to the walk's centre line (capped at 48).
| arg | type | description |
|---|
| self | any | |
| x | number | |
| z | number | |
barchan(du: number, dv: number, hd: number) → void
one barchan: (du, dv) from its centre in wind coordinates, hd its height
| arg | type | description |
|---|
| du | number | |
| dv | number | |
| hd | number | |
crescentField(u: number, v: number, Hd: number, seed: number, cellMul: number?, presence: number?) → void
| arg | type | description |
|---|
| u | number | |
| v | number | |
| Hd | number | |
| seed | number | |
| cellMul | number? | |
| presence | number? | |
linearField(u: number, v: number, Hd: number, seed: number, K: any) → void
| arg | type | description |
|---|
| u | number | |
| v | number | |
| Hd | number | |
| seed | number | |
| K | any | |
starField(x: number, z: number, Hd: number, seed: number) → void
| arg | type | description |
|---|
| x | number | |
| z | number | |
| Hd | number | |
| seed | number | |
transverseField(u: number, v: number, Hd: number, seed: number, bulge: number, reverse: boolean) → void
transverse ridges: long crests across the wind, a gentle windward (stoss) slope and a slip face
downwind; `bulge` bends each crest into linked crescents (barchanoid ridges), `reverse` gives a
slip face on both flanks (reversing dunes, where the wind swaps with the seasons)
| arg | type | description |
|---|
| u | number | |
| v | number | |
| Hd | number | |
| seed | number | |
| bulge | number | |
| reverse | boolean | |
parabolic(du: number, dv: number, hd: number) → void
one parabolic dune: a U whose nose points downwind with the slip face on its outside, its arms
trailing upwind and lowering, a scooped hollow inside (the reverse of a barchan)
| arg | type | description |
|---|
| du | number | |
| dv | number | |
| hd | number | |
parabolicField(u: number, v: number, Hd: number, seed: number) → void
| arg | type | description |
|---|
| u | number | |
| v | number | |
| Hd | number | |
| seed | number | |
domeField(x: number, z: number, Hd: number, seed: number) → void
dome dunes: low round mounds with no slip face, where the wind is too strong or the sand too coarse
| arg | type | description |
|---|
| x | number | |
| z | number | |
| Hd | number | |
| seed | number | |
dunesAt(self: any, x: number, z: number, Hd: number?) → void
Dune height (m) and lee weight (1 on a slip face) at a world point, before masks.
| arg | type | description |
|---|
| self | any | |
| x | number | |
| z | number | |
| Hd | number? | |
heroDune(self: any, x: number, z: number) → void
the hero dune the walk climbs: a ridge across the walk at the crest stop, its windward
slope facing the camp, its slip face falling toward the arch
| arg | type | description |
|---|
| self | any | |
| x | number | |
| z | number | |
archBand(self: any, x: number, z: number) → void
the rock band the arch stands in: a ridge of stepped sandstone across the walk, cut by the walk
| arg | type | description |
|---|
| self | any | |
| x | number | |
| z | number | |
rockAt(self: any, x: number, z: number, keep: number) → void
outcrops and mesas: stepped sandstone where the rock noise is high
| arg | type | description |
|---|
| self | any | |
| x | number | |
| z | number | |
| keep | number | |
baseAt(self: any, x: number, z: number) → number
the base relief: broad swells the dunes ride on
| arg | type | description |
|---|
| self | any | |
| x | number | |
| z | number | |
waterLevel(self: any) → number
The water level of the oasis pool.
| arg | type | description |
|---|
| self | any | |
ruinsLevel(self: any) → number
The level the ruined town's floor stands at.
| arg | type | description |
|---|
| self | any | |
shoreRadius(self: any, x: number, z: number) → number
the pool's shoreline radius in the direction of a point (it is not a circle)
| arg | type | description |
|---|
| self | any | |
| x | number | |
| z | number | |
panAt(self: any, x: number, z: number) → number
How much of a point is salt pan floor, 0..1 (0 in every kind but the salt pan).
| arg | type | description |
|---|
| self | any | |
| x | number | |
| z | number | |
ensureMacro(_self: any) → void
| arg | type | description |
|---|
| _self | any | |
contains(self: any, x: number, z: number, margin: number?) → boolean
Whether a world point lies on the desert's ground, at least `margin` metres in from its edge.
| arg | type | description |
|---|
| self | any | |
| x | number | |
| z | number | |
| margin | number? | |
sample(self: any, x: number, z: number) → void
The ground at a world point: height (m), lee slip-face weight 0..1, rock weight 0..1, flat (interdune) weight 0..1.
| arg | type | description |
|---|
| self | any | |
| x | number | |
| z | number | |
zoneAt(self: any, x: number, z: number, lee: number?, rock: number?, flat: number?) → void
Zone weights at a point: dunes, oasis, ruins, rocks, flat (sums to 1).
| arg | type | description |
|---|
| self | any | |
| x | number | |
| z | number | |
| lee | number? | |
| rock | number? | |
| flat | number? | |
describe(kind: string, shape: string?) → string
A short description of a kind and a dune shape.
| arg | type | description |
|---|
| kind | string | |
| shape | string? | |