threejs-worldgen
    Preparing search index...

    Interface PopulationOptions

    Every population setting. Plain data: save it, share it, send it to a worker, bind it to a GUI.

    interface PopulationOptions {
        cellSize: number;
        center: [number, number];
        corridor: number;
        farmsteadChance: number;
        habitability: HabitabilityOptions;
        hamletChance: number;
        jitter: number;
        landUse: LandUseThresholds;
        levels: number;
        lightDensity: number;
        location: [number, number] | null;
        minHabitability: number;
        network: NetworkOptions;
        radius: number;
        ruralDecay: number;
        ruralShare: number;
        seed: string | number;
        thresholds: SettlementThresholds;
        totalPopulation: number;
        urbanDensity: number;
        zipf: number;
    }
    Index
    cellSize: number

    Target edge length of the finest cells, metres (picks the nearest H3 resolution for this world).

    center: [number, number]

    Centre of the populated region in local [x, z], metres.

    corridor: number

    Extra rural density along rivers and coasts (corridors): × (1 + corridor × water access).

    farmsteadChance: number

    0…1 chance that a farmland cell has a farmstead.

    habitability: HabitabilityOptions

    Habitability model.

    hamletChance: number

    0…1 share of hamlet sites that are settled.

    jitter: number

    0…1 seeded jitter on site scores, so the lattice of central places looks natural.

    Land-use thresholds.

    levels: number

    Tiers of central places (1…4): urban centres, towns, villages, hamlets; one H3 resolution apart.

    lightDensity: number

    People per km² at which night lights reach 63 % brightness.

    location: [number, number] | null

    Planets: [latitude, longitude] of the local frame the region is in; null = world.frame.

    minHabitability: number

    Smoothed habitability a site needs to become a settlement.

    Road, rail and power networks.

    radius: number

    Radius of the populated region, metres.

    ruralDecay: number

    Rural density halves roughly every this many metres away from settlements.

    ruralShare: number

    0…1 share living dispersed in the countryside rather than in ranked settlements.

    seed: string | number

    Seed: the same seed, options and world always give the same population.

    Settlement class thresholds.

    totalPopulation: number

    People in the region.

    urbanDensity: number

    People per km² in a settlement's core; sets each settlement's radius.

    zipf: number

    Rank-size (Zipf) exponent: the r-th settlement has P₁ / rᵏ people.