five-on-it / packages/catalogue/src/region/build / regionMap
Function: regionMap()
regionMap(
spec,heights,roads?):string
Defined in: packages/catalogue/src/region/build.ts:196
The region as text: a line per row of tiles, north at the top and east to the right (the game's −x), each tile its highest corner's level (0–9, A for 10), a feature's peak or floor by its letter (H hill, M mountain, P plateau, V valley, L lake, X volcano, K a ski run's top), water ~ and lava *, a town's tiles T, the spawn apron S; under it, the legend.
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
roads?
readonly RegionRoad[] = []
Returns
string