Skip to content

five-on-it / packages/catalogue/src/region/build / RegionBuild

Interface: RegionBuild ​

Defined in: packages/catalogue/src/region/build.ts:118

A region, built.

Properties ​

bridges ​

bridges: object[]

Defined in: packages/catalogue/src/region/build.ts:128

The bridges' decks, in the game's frame, by name (bridge-<road>-<n>).

mesh ​

mesh: MeshDef

name ​

name: string


buildings ​

buildings: object[]

Defined in: packages/catalogue/src/region/build.ts:132

The region's own buildings (a hill's lighthouse, lighthouse.ts), in the game's frame, by name (lighthouse-<hill>).

mesh ​

mesh: MeshDef

name ​

name: string


groundHalfSize ​

groundHalfSize: number

Defined in: packages/catalogue/src/region/build.ts:156

Half the side of the level's square of ground (m).


heights ​

heights: RegionHeights

Defined in: packages/catalogue/src/region/build.ts:122

The corners' levels.


map ​

map: string

Defined in: packages/catalogue/src/region/build.ts:158

The region as text, north up and east to the right (see regionMap).


places ​

places: Record<string, RegionPoint>

Defined in: packages/catalogue/src/region/build.ts:154

The named places: tile_<i>_<j>, the features (their names, or <kind>_<n>: a peak, a floor, a plateau's middle, a lake's southern shore, a volcano's southern rim, a ski run's top, and its foot <name>_foot), each road's <name>_start and <name>_end, spawn_<n>.


props ​

props: RegionProp[]

Defined in: packages/catalogue/src/region/build.ts:134

The trees and rocks.


roads ​

roads: RegionRoadDef[]

Defined in: packages/catalogue/src/region/build.ts:126

The roads, each a centre line on the graded ground or a bridge's deck.


spawns ​

spawns: RegionPoint[]

Defined in: packages/catalogue/src/region/build.ts:148

The players' spawn points, a car's height over the apron, facing north.


spec ​

spec: object

Defined in: packages/catalogue/src/region/build.ts:120

The spec, its defaults filled in.

base ​

base: number

biome ​

biome: "meadow" | "forest" | "alpine" | "farmland" | "steppe" | "desert" | "autumn" | "coast"

climate? ​

optional climate?: "none" | "temperate" | "meadow" | "forest" | "alpine" | "farmland" | "steppe" | "desert" | "autumn" | "coast"

clock? ​

optional clock?: object

clock.pace ​

pace: number

clock.start ​

start: string

details ​

details: "plain" | "rich"

features ​

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 ​

landuse: object[]

name ​

name: string

props ​

props: object

props.rocks ​

rocks: boolean

props.trees ​

trees: boolean

roads ​

roads: object[]

seed ​

seed: number

size ​

size: [number, number]

start? ​

optional start?: string

template ​

template: "region"

towns ​

towns: object[]


terrain ​

terrain: MeshDef

Defined in: packages/catalogue/src/region/build.ts:124

The ground, in the game's frame, around the region's middle.


towns ​

towns: RegionTown[]

Defined in: packages/catalogue/src/region/build.ts:136

The towns, for the town generator to build on their footprints.


tunnels ​

tunnels: object & TunnelMeshes[]

Defined in: packages/catalogue/src/region/build.ts:130

The tunnels' roofs, portals and lights (tunnels.ts), in the game's frame, by name (tunnel-<road>-<n>).


water ​

water: object[]

Defined in: packages/catalogue/src/region/build.ts:138

The sheets of water and lava (a lake's, a volcano's), in the game's frame, by their features' names.

depth ​

depth: number

kind ​

kind: "water" | "lava"

name ​

name: string

width ​

width: number

x ​

x: number

y ​

y: number

z ​

z: number