Class DistrictMap

Answers "which district is this?" and "how dense is it here?" for one settlement.

Index

Constructors

Properties

axis cx cz mainStreet options radius shares

Methods

at density style

Constructors

constructor

new DistrictMap(
    options: DistrictOptions,
    shares: DistrictShares,
    cx: number,
    cz: number,
    radius: number,
    seed: number,
    mainStreet?: number,
    axis?: number,
): DistrictMap
District layout around (cx, cz) for a settlement of radius metres. With mainStreet > 0, downtown is a strip that wide either side of a street through the centre along axis (a town's high street) instead of a disc.
Parameters
- options: DistrictOptions
- shares: DistrictShares
- cx: number
- cz: number
- radius: number
- seed: number
- mainStreet: number = 0
- axis: number = 0
Returns DistrictMap
- Defined in city/src/districts.ts:89

Properties

`Readonly`axis

axis: number

Direction of the main street, radians from +x.

`Readonly`cx

cx: number

Settlement centre.

`Readonly`cz

cz: number

Settlement centre.

`Readonly`mainStreet

mainStreet: number

Half-width of the main-street downtown strip, metres (0 = downtown is a disc).

`Readonly`options

options: DistrictOptions

Rules in use.

`Readonly`radius

radius: number

Settlement radius, metres.

`Readonly`shares

shares: DistrictShares

District shares in use.

Methods

at

at(x: number, z: number): District
The district at (x, z).
Parameters
- x: number
- z: number
Returns District
- Defined in city/src/districts.ts:103

density

density(x: number, z: number): number
Building density 0..1: peaks downtown and falls off towards the edge (with a little noise).
Parameters
- x: number
- z: number
Returns number
- Defined in city/src/districts.ts:123

style

style(x: number, z: number): DistrictStyle
The rules of the district at (x, z).
Parameters
- x: number
- z: number
Returns DistrictStyle
- Defined in city/src/districts.ts:118