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

Function: addJetty()

addJetty(spec, plan, at): { selection: Selection; spec: { climate?: "none" | "temperate" | "meadow" | "forest" | "alpine" | "farmland" | "steppe" | "desert" | "autumn" | "coast"; clock?: { pace?: number; 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; }; template: "city"; water?: object[]; }; } | undefined

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

A jetty on the bank of the river nearest where the owner clicked (within its width and 30 m more), the side the click is on; the river's jetties until then are the solver's, kept.

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[] = ...

plan

CityPlan | undefined

at

Pt

Returns

{ selection: Selection; spec: { climate?: "none" | "temperate" | "meadow" | "forest" | "alpine" | "farmland" | "steppe" | "desert" | "autumn" | "coast"; clock?: { pace?: number; 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; }; template: "city"; water?: object[]; }; } | undefined