threejs-worldgen
    Preparing search index...

    Interface SettlementsCreateOptions

    Input of Settlements.create: settings plus the objects it needs.

    interface SettlementsCreateOptions {
        camera?: Camera;
        city?: DeepPartial<CityOptions>;
        frame?: LocalFrame;
        maxSettlements?: number;
        population?: DeepPartial<PopulationOptions>;
        scene?: Object3D<Object3DEventMap>;
        world: World;
    }

    Hierarchy

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

    Camera for level of detail.

    city?: DeepPartial<CityOptions>

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

    frame?: LocalFrame

    Frame to lay settlements out in (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).

    scene?: Object3D<Object3DEventMap>

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

    world: World

    The world.

    Settings
    Member Visibility

    On This Page
    Properties