five-on-it / apps/client/src/ui/studio/edits / addRiver

Function: addRiver()

addRiver(spec, points): object

Defined in: apps/client/src/ui/studio/edits.ts:188

A river through the points clicked, upstream first.

Parameters

spec

climate?

"none" | "temperate" | "meadow" | "forest" | "alpine" | "farmland" | "steppe" | "desert" | "autumn" | "coast" = ...

clock?

{ pace?: number; start?: string; } = ...

clock.pace?

number = ...

clock.start?

string = ...

districts

object[] = ...

grids?

object[] = ...

hills?

object[] = ...

name

string = ...

parks?

object[] = ...

places?

object[] = ...

roads?

object[] = ...

roundabouts?

object[] = ...

seed?

number = ...

size?

number = ...

spawn

{ near?: [number, number] | { at: [number, number]; grid: string; } | { arm: number; roundabout: string; } | { at: number | "start" | "end"; road: string; } | { hill: string; }; road: string; } = ...

spawn.near?

[number, number] | { at: [number, number]; grid: string; } | { arm: number; roundabout: string; } | { at: number | "start" | "end"; road: string; } | { hill: string; } = ...

spawn.road

string = ...

template

"city" = ...

water?

object[] = ...

points

readonly Pt[]

Returns

object

selection

selection: Selection

spec

spec: object

spec.climate?

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

spec.clock?

optional clock?: object

spec.clock.pace?

optional pace?: number

spec.clock.start?

optional start?: string

spec.districts

districts: object[]

spec.grids?

optional grids?: object[]

spec.hills?

optional hills?: object[]

spec.name

name: string

spec.parks?

optional parks?: object[]

spec.places?

optional places?: object[]

spec.roads?

optional roads?: object[]

spec.roundabouts?

optional roundabouts?: object[]

spec.seed?

optional seed?: number

spec.size?

optional size?: number

spec.spawn

spawn: object

spec.spawn.near?

optional near?: [number, number] | { at: [number, number]; grid: string; } | { arm: number; roundabout: string; } | { at: number | "start" | "end"; road: string; } | { hill: string; }

spec.spawn.road

road: string

spec.template

template: "city"

spec.water?

optional water?: object[]