world/kit.module — the building blocks world/District and world/Gasworks share:
boxes on primitives, the generated props at true size, flat decals on walls.
OWNED BY THE WORLD SLICE.
Every function takes the parent entity first, so each scene module keeps its
own root. Sizes are metres; ground is y = 0, +Z is north.
quat(ax: number, ay: number, az: number, degrees: number) → void
| arg | type | description |
|---|
| ax | number | |
| ay | number | |
| az | number | |
| degrees | number | |
rnd(seed: number) → number
| arg | type | description |
|---|
| seed | number | |
box(parent: any, name: string, px: number, py: number, pz: number, sx: number, sy: number, sz: number, material: string, mesh: string?) → void
| arg | type | description |
|---|
| parent | any | |
| name | string | |
| px | number | |
| py | number | |
| pz | number | |
| sx | number | |
| sy | number | |
| sz | number | |
| material | string | |
| mesh | string? | |
standing(parent: any, name: string, px: number, top: number, pz: number, sx: number, sz: number, material: string, mesh: string?, footing: number?) → void
A box whose top is at `top` and whose base is sunk 0.3 below its footing, so
no two horizontal faces ever share a height and shimmer at grazing angles.
| arg | type | description |
|---|
| parent | any | |
| name | string | |
| px | number | |
| top | number | |
| pz | number | |
| sx | number | |
| sz | number | |
| material | string | |
| mesh | string? | |
| footing | number? | |
prop(parent: any, name: string, kind: string, x: number, foot: number, z: number, scale: number, yaw: number?, opts: any?) → void
A generated prop standing on `foot`, turned `yaw` degrees about +Y.
| arg | type | description |
|---|
| parent | any | |
| name | string | |
| kind | string | |
| x | number | |
| foot | number | |
| z | number | |
| scale | number | |
| yaw | number? | |
| opts | any? | |
yawOf(nx: number, nz: number) → number
The yaw that turns +Z to face the horizontal direction (nx, nz).
| arg | type | description |
|---|
| nx | number | |
| nz | number | |
decal(parent: any, name: string, material: string, x: number, y: number, z: number, nx: number, nz: number, w: number, h: number) → void
A flat picture (poster, sign, window, door) w wide and h tall, its face
toward (nx, nz), reading the right way round from in front.
| arg | type | description |
|---|
| parent | any | |
| name | string | |
| material | string | |
| x | number | |
| y | number | |
| z | number | |
| nx | number | |
| nz | number | |
| w | number | |
| h | number | |
glow(parent: any, name: string, x: number, y: number, z: number, r: number, g: number, b: number, intensity: number, radius: number) → void
A warm light with no shadow: shop windows, gate lanterns, furnace glow.
| arg | type | description |
|---|
| parent | any | |
| name | string | |
| x | number | |
| y | number | |
| z | number | |
| r | number | |
| g | number | |
| b | number | |
| intensity | number | |
| radius | number | |
rod(parent: any, name: string, x0: number, y0: number, z0: number, x1: number, y1: number, z1: number, thick: number, material: string) → void
A cylinder rod from one point to another: washing lines, pipes, stays.
| arg | type | description |
|---|
| parent | any | |
| name | string | |
| x0 | number | |
| y0 | number | |
| z0 | number | |
| x1 | number | |
| y1 | number | |
| z1 | number | |
| thick | number | |
| material | string | |
lamp(parent: any, postName: string, flameName: string, x: number, foot: number, z: number, flameY: number, intensity: number, radius: number, seed: number, shadows: boolean?) → void
A generated gas lamp standing on `foot`, its flame a flickering point light
(LampFlicker) at `flameY`. The post casts no shadow so the light inside its
glass is never blocked by its own panes.
| arg | type | description |
|---|
| parent | any | |
| postName | string | |
| flameName | string | |
| x | number | |
| foot | number | |
| z | number | |
| flameY | number | |
| intensity | number | |
| radius | number | |
| seed | number | |
| shadows | boolean? | |