islands
The floating-island generator behind Floating Island Forge: turns options (look, shape, radius, depth, seed, stretch, bumps, hanging, roots, crags, debris, dressing) into mesh geometry, deterministic per seed. Called by the `FloatingIsland` component at runtime and by game code a…
islands
The floating-island generator behind Floating Island Forge: turns options (look, shape, radius, depth, seed, stretch, bumps, hanging, roots, crags, debris, dressing) into mesh geometry, deterministic per seed. Called by the FloatingIsland component at runtime and by game code at build time.
geometry(opts)-{ top, rock, roots, extras = { [slot] = geometry }, materials, pivots, look, shape }; every triangle is wound to agree with its vertex normals, and each geometry carriescreased(rock triangles given their own face-normal vertices at a crag fold)newBuf(),vtx,tri,quad,backFaces(buf),finish(buf, flat?)- the mesh-buffer helpers the dressing builds with;backFacesgives a two-sided sheet its back face on its own verticesbake(name, opts, folder?)- writes mesh assets<name>_top/_rock/_roots/_<slot>and returns refs forplaceBakedplaceBaked(parent, name, baked, position?, collider?)- spawns a baked island with colliderssurfaceY(opts, x, z)->(y, edgeT)- walkable top height at island-local x, z; edgeT 0 centre, 1 rim, >1 offradiusAt(opts, theta)- rim radius of the main part at an anglescatter(opts, count, seed?, maxEdge?, spacing?)- walkable spots for props and spawn pointsisOnTop(opts, x, z, margin?),parts(opts),material(name),look(name),lookNames(),shapes
Interface
What this asset declares: the schema it conforms to, what it exposes, and the rendered structured payload.
conforms to
zero/source-extract/v2strict
hash(i: number, j: number, seed: number) → number
| arg | type | description |
|---|---|---|
| i | number | |
| j | number | |
| seed | number |
smooth(t: number) → number return t
| arg | type | description |
|---|---|---|
| t | number |
noise2(x: number, y: number, seed: number) → number
| arg | type | description |
|---|---|---|
| x | number | |
| y | number | |
| seed | number |
fbm(x: number, y: number, seed: number, oct: number) → number
| arg | type | description |
|---|---|---|
| x | number | |
| y | number | |
| seed | number | |
| oct | number |
part(t: { [string]: any }, d: { [string]: any }?) → Part
| arg | type | description |
|---|---|---|
| t | { [string]: any } | |
| d | { [string]: any }? |
keyOf(o: IslandOpts) → string
| arg | type | description |
|---|---|---|
| o | IslandOpts |
resolve(o: IslandOpts) → Resolved
| arg | type | description |
|---|---|---|
| o | IslandOpts |
small(r: number) → void
| arg | type | description |
|---|---|---|
| r | number |
parts(o: IslandOpts) → void
The parts an island is built from (blobs and bands, island-local), for games that want to reason about its layout.
| arg | type | description |
|---|---|---|
| o | IslandOpts |
blobRadius(p: Part, th: number) → number
| arg | type | description |
|---|---|---|
| p | Part | |
| th | number |
blobTop(p: Part, x: number, z: number, edgeT: number) → number
| arg | type | description |
|---|---|---|
| p | Part | |
| x | number | |
| z | number | |
| edgeT | number |
bendZ(p: Part, x: number) → number
| arg | type | description |
|---|---|---|
| p | Part | |
| x | number |
blobSurface(p: Part, lipDrop: number, x: number, z: number) → void
(y, edgeT) of a blob at part-local x, z (z with the bend removed)
| arg | type | description |
|---|---|---|
| p | Part | |
| lipDrop | number | |
| x | number | |
| z | number |
bandWidth(p: Part, th: number, side: number) → number
| arg | type | description |
|---|---|---|
| p | Part | |
| th | number | |
| side | number |
bandS(p: Part, th: number) → number
| arg | type | description |
|---|---|---|
| p | Part | |
| th | number |
bandRise(p: Part, s: number) → number
| arg | type | description |
|---|---|---|
| p | Part | |
| s | number |
bandDepth(p: Part, s: number) → number
| arg | type | description |
|---|---|---|
| p | Part | |
| s | number |
bandTop(p: Part, x: number, z: number, edgeT: number) → number
| arg | type | description |
|---|---|---|
| p | Part | |
| x | number | |
| z | number | |
| edgeT | number |
bandSurface(p: Part, lipDrop: number, x: number, z: number) → void
| arg | type | description |
|---|---|---|
| p | Part | |
| lipDrop | number | |
| x | number | |
| z | number |
partSurface(p: Part, lipDrop: number, x: number, z: number) → void
(y, edgeT) of one part at island-local x, z
| arg | type | description |
|---|---|---|
| p | Part | |
| lipDrop | number | |
| x | number | |
| z | number |
radiusAt(o: IslandOpts, th: number) → number
Rim radius (before stretch) of the island's main part at polar angle `th` (radians, from +X toward +Z). For a ring it is the outer rim.
| arg | type | description |
|---|---|---|
| o | IslandOpts | |
| th | number |
surfaceY(o: IslandOpts, x: number, z: number) → void
Height of the walkable top at island-local (x, z), and how far out toward the rim it is (0 centre, 1 rim, >1 off the island). Over several parts the highest one standing there answers.
| arg | type | description |
|---|---|---|
| o | IslandOpts | |
| x | number | |
| z | number |
isOnTop(o: IslandOpts, x: number, z: number, margin: number?) → boolean
Whether island-local (x, z) is on the walkable top, at least `margin` (0..1 of the rim distance, default 0.85) in from the edge.
| arg | type | description |
|---|---|---|
| o | IslandOpts | |
| x | number | |
| z | number | |
| margin | number? |
scatter(o: IslandOpts, count: number, seed: number?, maxEdge: number?, spacing: number?) → void
`count` deterministic points on the walkable top, as { x, y, z, edgeT } in island-local space, at most `maxEdge` (default 0.8) out toward the rim and at least `spacing` metres apart (default 0). For props and spawn points.
| arg | type | description |
|---|---|---|
| o | IslandOpts | |
| count | number | |
| seed | number? | |
| maxEdge | number? | |
| spacing | number? |
newBuf( ) → Buf
vtx(b: Buf, x: number, y: number, z: number, u: number, v: number, c: { number }) → number
| arg | type | description |
|---|---|---|
| b | Buf | |
| x | number | |
| y | number | |
| z | number | |
| u | number | |
| v | number | |
| c | { number } |
tri(b: Buf, i: number, j: number, k: number) → void
a triangle whose front face is the side its (b - a) x (c - a) normal points to
| arg | type | description |
|---|---|---|
| b | Buf | |
| i | number | |
| j | number | |
| k | number |
cross(b: Buf, i: number, j: number, k: number) → void
| arg | type | description |
|---|---|---|
| b | Buf | |
| i | number | |
| j | number | |
| k | number |
quad(b: Buf, a: number, bb: number, c: number, d: number) → void
a grid quad with upper row a-b and lower row c-d, front face (a, c, b) + (b, c, d); where a steep neighbouring column folds that diagonal back through the quad, it splits along the other diagonal
| arg | type | description |
|---|---|---|
| b | Buf | |
| a | number | |
| bb | number | |
| c | number | |
| d | number |
facing(i: number, j: number, k: number) → number
| arg | type | description |
|---|---|---|
| i | number | |
| j | number | |
| k | number |
copyVtx(b: Buf, v: number) → number
| arg | type | description |
|---|---|---|
| b | Buf | |
| v | number |
backFaces(b: Buf) → void
For a two-sided sheet (a strand, a blade, a sail): returns `back(i, j, k)`, which emits a back face on copies of the vertices so the back carries its own (opposite) normals instead of cancelling the front's. Pass the back face's own winding; one `backFaces` per sheet keeps the back smooth.
| arg | type | description |
|---|---|---|
| b | Buf |
dup(v: number) → number
| arg | type | description |
|---|---|---|
| v | number |
mix(a: { number }, b: { number }, t: number, k: number?) → void
| arg | type | description |
|---|---|---|
| a | { number } | |
| b | { number } | |
| t | number | |
| k | number? |
finish(b: Buf, flat: boolean?, boxUv: number?) → any
Turn a buffer into the geometry table `asset.create("mesh")` and `renderer.mesh.create` take, with smooth (or, `flat`, faceted) normals. Nil when empty. `boxUv` (metres per texture tile) replaces the buffer's UVs with a world-space box projection, one even texel density on every face; the vertices it had to copy at axis seams are counted in `uvSplit`.
| arg | type | description |
|---|---|---|
| b | Buf | |
| flat | boolean? | |
| boxUv | number? |
cliffProfile(p: Part, G: Looks.Geo, crags: number, t: number, th: number) → number
radial fraction of the rim at depth fraction t (0 under the lip, 1 at the tip) and angle th
| arg | type | description |
|---|---|---|
| p | Part | |
| G | Looks.Geo | |
| crags | number | |
| t | number | |
| th | number |
rockColour(L: Looks.Look, t: number, seam: boolean, ledge: boolean) → void
| arg | type | description |
|---|---|---|
| L | Looks.Look | |
| t | number | |
| seam | boolean | |
| ledge | boolean |
strand(out: Out, L: Looks.Look, n: number, seed: number, cx: number, topY: number, cz: number, ox: number, oz: number, amount: number, depth: number) → void
| arg | type | description |
|---|---|---|
| out | Out | |
| L | Looks.Look | |
| n | number | |
| seed | number | |
| cx | number | |
| topY | number | |
| cz | number | |
| ox | number | |
| oz | number | |
| amount | number | |
| depth | number |
rockLump(b: Buf, cx: number, cy: number, cz: number, size: number, seed: number, col: { number }, squash: number?) → void
a lumpy low-poly rock, for floating debris and dressing
| arg | type | description |
|---|---|---|
| b | Buf | |
| cx | number | |
| cy | number | |
| cz | number | |
| size | number | |
| seed | number | |
| col | { number } | |
| squash | number? |
buildBlob(out: Out, r: Resolved, p: Part) → void
| arg | type | description |
|---|---|---|
| out | Out | |
| r | Resolved | |
| p | Part |
place(x: number, y: number, z: number) → void
| arg | type | description |
|---|---|---|
| x | number | |
| y | number | |
| z | number |
buildBand(out: Out, r: Resolved, p: Part) → void
| arg | type | description |
|---|---|---|
| out | Out | |
| r | Resolved | |
| p | Part |
at(i: number) → number
| arg | type | description |
|---|---|---|
| i | number |
geometry(o: IslandOpts) → any
Build the geometry of one island. Returns { top, rock, roots, extras = { [slot] = geometry }, materials = { top, rock, roots, [slot] = material name }, look, shape }, each geometry in the flat-array shape `asset.create("mesh")` and `renderer.mesh.create` take (nil when empty).
| arg | type | description |
|---|---|---|
| o | IslandOpts |
material(name: any) → any
Resolve a material a look uses (a short name such as "meadow_top", see materials.module) to a material ref; a material ref passes through unchanged.
| arg | type | description |
|---|---|---|
| name | any |
look(name: string?) → Looks
The look table for `name` (see looks.module), meadow when unknown.
| arg | type | description |
|---|---|---|
| name | string? |
lookNames( ) → void
Every look name, in gallery order.
bake(name: string, o: IslandOpts, folder: string?) → any
Bake an island as mesh assets `<name>_top`, `<name>_rock`, `<name>_roots` and `<name>_<slot>` (dressing) in `folder` under /source (default "floatingIslands/baked"), overwriting in place (guids kept). Returns { meshes = { slot = mesh ref }, materials = { slot = material ref }, pivots, look, shape }: hand it to `placeBaked`.
| arg | type | description |
|---|---|---|
| name | string | |
| o | IslandOpts | |
| folder | string? |
put(slot: string, geo: any) → void
| arg | type | description |
|---|---|---|
| slot | string | |
| geo | any |
placeBaked(parent: any?, entityName: string, baked: any, position: { number }?, collider: boolean?) → any
Spawn a baked island (`bake`'s answer) under `parent` as Model entities, its origin at `position`: top, rock and solid dressing get exact MeshColliders (walkable) unless `collider` is false; roots, foliage, water and lava are visual only; a windmill's sails get an IslandRotor so they turn. Returns the root entity.
| arg | type | description |
|---|---|---|
| parent | any? | |
| entityName | string | |
| baked | any | |
| position | { number }? | |
| collider | boolean? |
IslandOpts = {Part = {Buf = { pos: { number }, idx: { number }, uvs: { number }, cols: { number } }Sub-parts
Everything contained inside this part. Assets are composite children (clickable cards). Files are leaf payloads. Expand any row to view its source.
Showing up to 3 levels deep. Open a part to see what it holds further down.
Problems
Everything affecting this asset right now: its own problems, anything wrong inside it, and problems on its direct dependencies.
agent_score is exposed.+ quality × 0.35
+ performance × 0.25
± compat factor
Usability ratings
Did the part work as advertised when consumers tried to drop it in. Separate from upvotes: those are taste; this is "did it function".
Scoped to this part · feeds back into the world's score.