faceYaw(dx: number, dz: number) → number
yaw that makes a building's front face the direction (dx, dz)
| arg | type | description |
|---|
| dx | number | |
| dz | number | |
rect(g: any, slot: string, x0: number, z0: number, x1: number, z1: number, top: number, th: number?) → void
| arg | type | description |
|---|
| g | any | |
| slot | string | |
| x0 | number | |
| z0 | number | |
| x1 | number | |
| z1 | number | |
| top | number | |
| th | number? | |
road(g: any, x0: number, z0: number, x1: number, z1: number, slot: string?) → void
a cobbled road with kerb stones down both long sides
| arg | type | description |
|---|
| g | any | |
| x0 | number | |
| z0 | number | |
| x1 | number | |
| z1 | number | |
| slot | string? | |
groundPlane(g: any, half: number) → void
| arg | type | description |
|---|
| g | any | |
| half | number | |
building(ctx: any, kind: string, x: number, z: number, yaw: number, extra: any?) → any
| arg | type | description |
|---|
| ctx | any | |
| kind | string | |
| x | number | |
| z | number | |
| yaw | number | |
| extra | any? | |
prop(ctx: any, kind: string, x: number, z: number, yaw: number?, extra: any?) → void
| arg | type | description |
|---|
| ctx | any | |
| kind | string | |
| x | number | |
| z | number | |
| yaw | number? | |
| extra | any? | |
anchor(ctx: any, name: string, x: number, z: number, yaw: number?) → void
| arg | type | description |
|---|
| ctx | any | |
| name | string | |
| x | number | |
| z | number | |
| yaw | number? | |
spot(ctx: any, kind: string, x: number, z: number, yaw: number?, tag: string?) → void
| arg | type | description |
|---|
| ctx | any | |
| kind | string | |
| x | number | |
| z | number | |
| yaw | number? | |
| tag | string? | |
row(ctx: any, ax: number, az: number, bx: number, bz: number, fx: number, fz: number, mix: { string }, opts: any?) → void
Fill a street frontage from (ax, az) to (bx, bz) with buildings whose fronts face
(fx, fz). `mix` is the list of kinds to draw from. Returns the buildings placed.
| arg | type | description |
|---|
| ctx | any | |
| ax | number | |
| az | number | |
| bx | number | |
| bz | number | |
| fx | number | |
| fz | number | |
| mix | { string } | |
| opts | any? | |
lamps(ctx: any, ax: number, az: number, bx: number, bz: number, step: number) → void
lamps every `step` metres along a line, set `off` metres to the side
| arg | type | description |
|---|
| ctx | any | |
| ax | number | |
| az | number | |
| bx | number | |
| bz | number | |
| step | number | |
alley(ctx: any, g: any, x0: number, z0: number, x1: number, z1: number) → void
a back alley: a narrow cobbled lane with clutter and an anchor in the middle
| arg | type | description |
|---|
| ctx | any | |
| g | any | |
| x0 | number | |
| z0 | number | |
| x1 | number | |
| z1 | number | |
finishGround(ctx: any, g: any) → void
| arg | type | description |
|---|
| ctx | any | |
| g | any | |
castleTown(ctx: any) → any
wallRun(x0: number, z0: number, x1: number, z1: number) → void
walls with towers at the corners and gaps for the roads
| arg | type | description |
|---|
| x0 | number | |
| z0 | number | |
| x1 | number | |
| z1 | number | |
riverVillage(ctx: any) → any
build(id: string, ctx: any) → any
Build layout `id` into ctx (made by townKit.api's place). Returns its bounds
{ minX, minZ, maxX, maxZ } in town-local metres.
| arg | type | description |
|---|
| id | string | |
| ctx | any | |