five-on-it / packages/catalogue/src/city/terrain / compoundsOf

Function: compoundsOf()

compoundsOf(spec, net, districts, relief, lakes, issues): PlanCompound[]

Defined in: packages/catalogue/src/city/terrain.ts:441

The walled compounds the districts ask for (see the module documentation): each on its district's largest rectangle free of the streets' pavements, the water, the parks and the lakes, cut to 112 m a side from its gate's wall; each problem at its district's path.

Parameters

spec

climate?

"none" | "temperate" | "meadow" | "forest" | "alpine" | "farmland" | "steppe" | "desert" | "autumn" | "coast" = ...

clock?

{ pace: number; start: string; } = ...

clock.pace

number = ...

clock.start

string = ...

districts

object[] = ...

grids

object[] = ...

hills

object[] = ...

lakes

object[] = ...

name

string = ...

parks

object[] = ...

places

object[] = ...

relief

({ at: [number, number] | { at: [number, number]; grid: string; } | { arm: number; roundabout: string; } | { at: number | "start" | "end"; road: string; } | { hill: string; }; height: number; kind: "rise"; reach: number; } | { from: [number, number] | { at: [number, number]; grid: string; } | { arm: number; roundabout: string; } | { at: number | "start" | "end"; road: string; } | { hill: string; }; height: number; kind: "slope"; to: [number, number] | { at: [number, number]; grid: string; } | { arm: number; roundabout: string; } | { at: number | "start" | "end"; road: string; } | { hill: string; }; })[] = ...

roads

object[] = ...

roundabouts

object[] = ...

seed

number = ...

size

number = ...

spawn

{ near?: [number, number] | { at: [number, number]; grid: string; } | { arm: number; roundabout: string; } | { at: number | "start" | "end"; road: string; } | { hill: string; }; road: string; } = ...

spawn.near?

[number, number] | { at: [number, number]; grid: string; } | { arm: number; roundabout: string; } | { at: number | "start" | "end"; road: string; } | { hill: string; } = ...

spawn.road

string = ...

template

"city" = ...

water

object[] = ...

net

Network

districts

DistrictLayout

relief

CityRelief

lakes

readonly Pt[][]

issues

SpecIssue[]

Returns

PlanCompound[]