five-on-it / packages/catalogue/src/city/plan / PlanDistrict

Interface: PlanDistrict

Defined in: packages/catalogue/src/city/plan.ts:136

A district: its name, its style (styles.json), its title on the minimap, the landmarks it must have, and what the spec says over its style: its theme, its mix (its landuse's buildings when it names a landuse and no mix), its density field by field.

Properties

density?

optional density?: object

Defined in: packages/catalogue/src/city/plan.ts:143

built?

optional built?: number

height?

optional height?: "low" | "high" | "mixed"

setback?

optional setback?: number

---

landmarks

landmarks: string[]

Defined in: packages/catalogue/src/city/plan.ts:140

---

mix?

optional mix?: Record<string, number>

Defined in: packages/catalogue/src/city/plan.ts:142

---

name

name: string

Defined in: packages/catalogue/src/city/plan.ts:137

---

style

style: string

Defined in: packages/catalogue/src/city/plan.ts:138

---

theme?

optional theme?: string

Defined in: packages/catalogue/src/city/plan.ts:141

---

title?

optional title?: string

Defined in: packages/catalogue/src/city/plan.ts:139