five-on-it / packages/catalogue/src/region/roads / routeRoads

Function: routeRoads()

routeRoads(spec, heights): object

Defined in: packages/catalogue/src/region/roads.ts:105

Routes every road of a region's spec over its tiles (see the module documentation), with what could not be routed.

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[] = ...

heights

RegionHeights

Returns

object

exits

exits: RegionExit[]

issues

issues: SpecIssue[]

roads

roads: RegionRoad[]