Five On It

Appearance

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

Interface: RegionTown ​

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

A town of a region as the town generator builds it (assets/blender/levels/generate.py with --relief): its grid-town spec, the land it stands on and where it goes. In the town's own frame (x, z from the footprint's middle, the game's axes), heights in metres.

Properties ​

kit ​

kit: string

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

Its kit's name and its spec's: <region>-<town>.

name ​

name: string

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

The town's name in the region's spec: its places' prefix.

relief ​

relief: object

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

The land under it.

blockTiles ​

blockTiles: number

Tiles across a block.

exits ​

exits: object[]

The roads of the region that end at it: the side and street line they come in by, the point, the road's class and width.

footprint ​

footprint: [number, number]

Its footprint, in tiles along x and z.

grass ​

grass: [number, number, number]

The region's grass (its biome's), for the town's verge.

heightStep ​

heightStep: number

levels ​

levels: number[]

The levels of the footprint's corners, (w + 1) × (h + 1), row by row along x from its south-east corner.

seam ​

seam: [number, number, number][]

The region's ground on the footprint's outline, a point every 4 m round it (the corners once each): what the town's ground meets.

tile ​

tile: number

A tile's side and a level's height (m).

shift ​

shift: object

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

Where its frame's origin stands in the region's (m).

x ​

x: number

z ​

z: number

spec ​

spec: Record<string, unknown>

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

The grid-town spec it is built from (its blocks a tile or two across, no compounds).