FloraKit: the desert-specific helpers every desertProps vegetation generator
builds with, on top of tropicalProps' VegGeo mesh kit (tool code: the bakers
call it; nothing here runs in gameplay).
local K = require("~.FloraKit")
local out = K.perLod({ "leaves", "stems" }, function(lod, ps) ... end)
K.finish(out, "low") -- facets the low form, shares one box per LOD
K.tufts(g, base, 0.6, 5, 2, 0.4, rng, { 1, 1, 1 }) -- alpha tuft cards (v = 0 at the ground)
K.blade(g, spine, sideRef, widthFn, colFn, alphaFn) -- one leaf/blade card along a spine
K.limb(g, pts, r0, r1, sides, tint) -- a woody tube, 1 uv = 1 m
Mesh contract (tropicalProps): metres, +Y up, origin at the ground contact,
vertex RGB tints the material, vertex A is the wind weight on foliage.
clamp01(x: number) → number return math
| arg | type | description |
|---|
| x | number | |
smooth(x: number) → number
| arg | type | description |
|---|
| x | number | |
seed(kind: string, variant: number) → number
The seed of a kind's variant (same rule as tropicalProps).
| arg | type | description |
|---|
| kind | string | |
| variant | number | |
style(form: string) → Style
Count and size multipliers of a form: real (full), toon (fewer, bigger, rounder), low (fewest, faceted).
| arg | type | description |
|---|
| form | string | |
perLod(names: { string }, build: (lod: number, ps: any) → void
{ lods = { [0..2] = parts } } with one empty VegGeo geometry per part name, filled by build(lod, parts).
| arg | type | description |
|---|
| names | { string } | |
| build | (lod: number, ps: any | |
finish(out: any, form: string) → any
Finish a generated prop: the low form is faceted (flat normals), and every part of one LOD gets the same bounding box.
| arg | type | description |
|---|
| out | any | |
| form | string | |
tint(rng: any, base: { number }, var: number) → void
A tint near `base`: darker by up to `var`, with a little hue drift.
| arg | type | description |
|---|
| rng | any | |
| base | { number } | |
| var | number | |
curve(p0: { number }, d0: { number }, L: number, steps: number, gravity: number, wiggle: number, seed: number) → void
A curved path from p0 heading d0: L metres in `steps`, bending `gravity` per metre (+ up, - down), with a seeded wiggle.
| arg | type | description |
|---|
| p0 | { number } | |
| d0 | { number } | |
| L | number | |
| steps | number | |
| gravity | number | |
| wiggle | number | |
| seed | number | |
limb(g: any, pts: { { number } }, r0: number, r1: number, sides: number, col: { number } | (t: number) → void
A woody tube (branch, stem, trunk) from r0 to r1 with a tint; uv: u wraps the bark once per metre of girth, v = metres along. `alphaTip` > 0 makes it sway (drawn with a leaf material: samples the leaf's midrib strip).
| arg | type | description |
|---|
| g | any | |
| pts | { { number } } | |
| r0 | number | |
| r1 | number | |
| sides | number | |
| col | { number } | (t: number | |
radius(i: ?, t: ?) → void
blade(g: any, spine: { { number } }, sideRef: { number }, width: (t: number) → void
One card along a spine (a blade, leaf, frond half): u 0..1 across (midrib 0.5), v 0 base -> 1 tip. `sideRef` is the across direction it starts from; width(t) the half width.
| arg | type | description |
|---|
| g | any | |
| spine | { { number } } | |
| sideRef | { number } | |
| width | (t: number | |
card(g: any, base: { number }, ax: { number }, ay: { number }, w: number, h: number, col: { number }, a0: number, a1: number, nrm: { number }?) → void
A flat quad card centred on its bottom edge at `base`: across `ax` (half width w), up `ay` (height h). u across, v 0 bottom -> 1 top.
| arg | type | description |
|---|
| g | any | |
| base | { number } | |
| ax | { number } | |
| ay | { number } | |
| w | number | |
| h | number | |
| col | { number } | |
| a0 | number | |
| a1 | number | |
| nrm | { number }? | |
tufts(g: any, base: { number }, h: number, cards: number, segs: number, spread: number, rng: any, col0: { number }, widthMul: number?) → void
Alpha tuft cards round a point (grass clumps): `cards` crossed cards, `segs` rows each, leaning out by up to `spread`. v = 0 at the ground.
| arg | type | description |
|---|
| g | any | |
| base | { number } | |
| h | number | |
| cards | number | |
| segs | number | |
| spread | number | |
| rng | any | |
| col0 | { number } | |
| widthMul | number? | |
starCards(g: any, c: { number }, axis: { number }, n: number, w: number, h: number, col: { number }, a: number, rng: any) → void
A star of `n` crossed quad cards round an axis at `c` (for blooms, plumes and tumbleweeds): each w x h, u across, v from the centre outward.
| arg | type | description |
|---|
| g | any | |
| c | { number } | |
| axis | { number } | |
| n | number | |
| w | number | |
| h | number | |
| col | { number } | |
| a | number | |
| rng | any | |