Skip to content

five-on-it / packages/catalogue/src/region/towns / townFootprints

Function: townFootprints() ​

townFootprints(spec): TownFootprint[]

Defined in: packages/catalogue/src/region/towns.ts:43

Every town's footprint, in the spec's order.

Parameters ​

spec ​

base ​

number = ...

biome ​

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

climate? ​

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

clock? ​

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

clock.pace ​

number = ...

clock.start ​

string = ...

details ​

"plain" | "rich" = ...

features ​

({ at: [number, number]; kind: "hill"; level: number; lighthouse?: boolean; name?: string; radius?: number; steep?: boolean; } | { at: [number, number]; kind: "mountain"; level: number; name?: string; radius?: number; } | { at: [number, number]; kind: "plateau"; level: number; name?: string; size: [number, number]; } | { at: [number, number]; kind: "valley"; level: number; name?: string; radius: number; steep?: boolean; } | { at: [number, number]; kind: "lake"; level: number; name?: string; size: [number, number]; } | { at: [number, number]; flow?: "north" | "east" | "south" | "west"; kind: "volcano"; level: number; name?: string; radius?: number; } | { at: [number, number]; kind: "ski"; name?: string; to: [number, number]; })[] = ...

landuse ​

object[] = ...

name ​

string = ...

props ​

{ rocks: boolean; trees: boolean; } = ...

props.rocks ​

boolean = ...

props.trees ​

boolean = ...

roads ​

object[] = ...

seed ​

number = ...

size ​

[number, number] = ...

start? ​

string = ...

template ​

"region" = ...

towns ​

object[] = ...

Returns ​

TownFootprint[]