df_fauna_upper
One-paragraph description of what this module provides and who consumes it.
df_fauna_upper
One-paragraph description of what this module provides and who consumes it.
Exports
M.exampleFn(arg) -> result— what it does and when to call it.M.exampleValue: type— what value it carries.
Usage
local M = require("@<youridentity>::modules.df_fauna_upper")
M.exampleFn("foo")
Notes
- Anything callers need to know about THIS module: required runtime ordering, state ownership, side effects.
Interface
What this asset declares: the schema it conforms to, what it exposes, and the rendered structured payload.
conforms to
zero/source-extract/v2The workshop the six fringe-and-twilight animals are built in. Six species modules share one vocabulary: a way to hang a shaped, materialled part on a body, a place to remember which part is which so a swim cycle can address them by name every frame, and the handful of curves that make a swim read as an animal rather than as a sine wave. MEASURED, NOT ASSUMED: every builtin primitive is UNIT SIZED, so a scale is the part's FULL EXTENT in metres, not its radius. `sphere`, `cube`, `cone`, `cylinder` and `octahedron` are 1 x 1 x 1. `plane` is 1 x 0 x 1, flat in Y. `torus` is 1 x 0.3 x 1. `capsule` is 0.5 x 1 x 0.5 — HALF as wide as its scale says, so a capsule's X and Z scale is twice the width you want. Slice owner: fauna-upper.
part(parent: any, name: string, model: string, mat: string, pos: any, scale: any, rot: any) → any
Building a body `part` is how every piece of every animal is made: a primitive, a material, and a place to stand. Creatures never cast shadows — the lamp carries a limited shadow budget and the game is read off the lit surface, not off what the animal throws behind it.
| arg | type | description |
|---|---|---|
| parent | any | |
| name | string | |
| model | string | |
| mat | string | |
| pos | any | |
| scale | any | |
| rot | any |
pivot(parent: any, name: string, pos: any, rot: any) → any
A bare joint with no geometry — something to swing a limb from, so the limb rotates about its base instead of sliding around.
| arg | type | description |
|---|---|---|
| parent | any | |
| name | string | |
| pos | any | |
| rot | any |
radial(parent: any, name: string, a: number, radius: number, y: number) → any
A limb standing on the rim of a radially symmetric animal, at bearing `a` radians and `radius` metres out from the axis. The returned inner joint is yawed so that its own +Z points straight OUT from the animal and its +X runs along the rim. So a limb built hanging down the joint's -Y swings OUTWARD as the joint's euler X goes negative and inward as it goes positive — one number, in the plane you want it in, with no euler ordering to reason about at the call site.
| arg | type | description |
|---|---|---|
| parent | any | |
| name | string | |
| a | number | |
| radius | number | |
| y | number |
setRig(root: any, parts: any) → void
| arg | type | description |
|---|---|---|
| root | any | |
| parts | any |
rig(root: any) → any
| arg | type | description |
|---|---|---|
| root | any |
forget(root: any) → void
| arg | type | description |
|---|---|---|
| root | any |
readability(ctx: any) → number
Light response How much detail the animal should be showing right now: 0 is a pure silhouette, 1 is every photophore countable. Everything that grades an animal's look goes through this so the journal's promise stays one number.
| arg | type | description |
|---|---|---|
| ctx | any |
tint(e: any, col: any, blend: number) → void
Per-entity recolour. Materials are registry-wide, so this is the only way one animal flushes darker without repainting every animal that shares its skin.
| arg | type | description |
|---|---|---|
| e | any | |
| col | any | |
| blend | number |
glow(matName: string, intensity: number) → void
| arg | type | description |
|---|---|---|
| matName | string | |
| intensity | number |
wave(t: number, i: number, speed: number, lag: number) → number
Curves that read as swimming A travelling wave down a chain of segments: `i` is the segment index, and the phase lag is what turns a row of parts into something that undulates rather than something that wobbles in unison.
| arg | type | description |
|---|---|---|
| t | number | |
| i | number | |
| speed | number | |
| lag | number |
shuttle(t: number, period: number, duty: number) → number
Out fast, back slow, and back to exactly where it started at the end of every cycle — so an animal shuttles in place instead of climbing out of the frame. Returns 0 at rest, 1 at full reach.
| arg | type | description |
|---|---|---|
| t | number | |
| period | number | |
| duty | number |
stroking(t: number, period: number, duty: number) → number
1 while the stroke is being thrown, 0 while it coasts.
| arg | type | description |
|---|---|---|
| t | number | |
| period | number | |
| duty | number |
pulse(t: number, rate: number, snap: number) → number
A pulse with a fast contraction and a slow relaxation — the asymmetry that makes a jelly read as a jelly instead of as a bobbing dome.
| arg | type | description |
|---|---|---|
| t | number | |
| rate | number | |
| snap | number |
plate(size: number, body: string) → any
| arg | type | description |
|---|---|---|
| size | number | |
| body | string |
Sub-parts
Everything contained inside this part. Assets are composite children (clickable cards). Files are leaf payloads. Expand any row to view its source.
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.