threejs-worldgen
    Preparing search index...

    Interface CityCreateOptions

    Options for City.create: settings plus the objects a city needs (not JSON).

    interface CityCreateOptions {
        architecture?: ArchitectureName | "auto";
        architectures?: DeepPartial<Record<ArchitectureName, Architecture>>;
        blocks?: DeepPartial<BlockOptions>;
        buildBudget?: number;
        buildings?: DeepPartial<BuildingOptions>;
        camera?: Camera;
        center?: [number, number];
        climate?: Climate | null;
        districts?: DeepPartial<DistrictOptions>;
        facade?: DeepPartial<FacadeOptions>;
        farm?: DeepPartial<FarmOptions>;
        field?: DeepPartial<TensorFieldOptions>;
        frame?: LocalFrame;
        landmarks?: DeepPartial<LandmarkOptions>;
        lod?: DeepPartial<LodOptions>;
        lotJitter?: number;
        progressive?: boolean;
        radius?: number;
        roadLook?: DeepPartial<RoadLookOptions>;
        roads?: DeepPartial<RoadOptions>;
        roadside?: DeepPartial<RoadsideOptions>;
        scene?: Object3D<Object3DEventMap>;
        seed?: string | number;
        siteResolution?: number;
        size?: SettlementSize;
        sizes?: DeepPartial<Record<SettlementSize, SizeClass>>;
        style?: RoadStyle | "auto";
        terrain?: DeepPartial<TerrainOptions>;
        weather?: DeepPartial<WeatherOptions>;
        world: World;
    }

    Hierarchy (View Summary)

    Index
    architecture? architectures? blocks? buildBudget? buildings? camera? center? climate? districts? facade? farm? field? frame? landmarks? lod? lotJitter? progressive? radius? roadLook? roads? roadside? scene? seed? siteResolution? size? sizes? style? terrain? weather? world
    architecture?: ArchitectureName | "auto"

    Regional building tradition; 'auto' picks one from the climate at the centre.

    architectures?: DeepPartial<Record<ArchitectureName, Architecture>>

    The architectures (materials, roofs, stilts, balconies, …).

    blocks?: DeepPartial<BlockOptions>

    Block extraction.

    buildBudget?: number

    Milliseconds per update() spent generating when progressive.

    buildings?: DeepPartial<BuildingOptions>

    Building rules.

    camera?: Camera

    Camera for level of detail. Without one, everything stays at full detail.

    center?: [number, number]

    Centre, frame-local [x, z] metres.

    climate?: Climate | null

    Climate override for 'auto' architecture (null = read from the world at the centre).

    districts?: DeepPartial<DistrictOptions>

    District layout and per-district rules.

    facade?: DeepPartial<FacadeOptions>

    Facades and roofs.

    farm?: DeepPartial<FarmOptions>

    Farmsteads (size: 'farmstead'): yard, buildings, driveway, fields and crops.

    field?: DeepPartial<TensorFieldOptions>

    Street direction field.

    frame?: LocalFrame

    Local frame the settlement is laid out in (world.frame by default; world.frameAt(lat, lon) on planets).

    landmarks?: DeepPartial<LandmarkOptions>

    Churches, town halls and water towers (how many each size class gets is in sizes).

    lod?: DeepPartial<LodOptions>

    Level of detail.

    lotJitter?: number

    Lot split jitter: 0 = regular halves, 1 = very uneven.

    progressive?: boolean

    Spread generation over several frames (see buildBudget) instead of finishing in create.

    radius?: number

    Radius, metres (0 = the middle of the size class's range).

    roadLook?: DeepPartial<RoadLookOptions>

    Road surfaces.

    roads?: DeepPartial<RoadOptions>

    Road network rules.

    roadside?: DeepPartial<RoadsideOptions>

    Lots along roads through open ground (outside blocks).

    scene?: Object3D<Object3DEventMap>

    If given, the city is added to it and updates itself via scene.onBeforeRender.

    seed?: string | number

    Seed: same seed, options and world give the same settlement.

    siteResolution?: number

    Terrain sampling resolution, metres (0 = automatic from the radius).

    size?: SettlementSize

    Size class (sets radius, height limit, layout style and district shares).

    sizes?: DeepPartial<Record<SettlementSize, SizeClass>>

    Size classes.

    style?: RoadStyle | "auto"

    Street layout; 'auto' takes the size class's.

    terrain?: DeepPartial<TerrainOptions>

    Terrain shaping.

    weather?: DeepPartial<WeatherOptions>

    Weather and wear per material group (hooks for a weather system).

    world: World

    The world the settlement stands on (its height, water and climate; flattening goes here).

    Settings
    Member Visibility

    On This Page
    Properties