five-on-it / packages/catalogue/src/city/map / cityMap
Function: cityMap()
cityMap(
spec,net,districts,junctions,spawn):string
Defined in: packages/catalogue/src/city/map.ts:36
The city as text (see the module documentation).
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[] = ...
name
string = ...
parks
object[] = ...
places
object[] = ...
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
districts
cell
number
cells
Int16Array
cols
number
junctions
readonly Junction[]
spawn
Returns
string