threejs-worldgen
    Preparing search index...

    Interface SettlementsProps

    Props of <Settlements>: every SettlementsOptions setting plus the objects below.

    interface SettlementsProps {
        camera?: Camera;
        city?: DeepPartial<CityOptions>;
        frame?: LocalFrame;
        maxSettlements?: number;
        population?: DeepPartial<PopulationOptions>;
        ref?: Ref<Settlements | null>;
        world: World;
    }

    Hierarchy

    Index
    camera? city? frame? maxSettlements? population? ref? world
    camera?: Camera

    LOD camera; defaults to the R3F camera.

    city?: DeepPartial<CityOptions>

    Settings shared by every settlement (centre, size, radius and seed come from the population; sizes maps it onto cities).

    frame?: LocalFrame

    Layout frame (world.frame by default).

    maxSettlements?: number

    Most settlements to build, largest first.

    population?: DeepPartial<PopulationOptions>

    Where people live: the population model's settings (its center and radius are the area to populate).

    ref?: Ref<Settlements | null>

    Receives the underlying Settlements group.

    world: World

    The world to populate.

    Settings
    Member Visibility

    On This Page
    Properties