hex-world
    Preparing search index...

    Interface VolcanoOptions

    interface VolcanoOptions {
        volcanoes?: number;
        volcanoRadius?: number;
        volcanoHeight?: number;
        volcanoLavaTerrain?: number;
        volcanoAshTerrain?: number;
        volcanoAshRadius?: number;
        volcanoSmokeLayer?: number;
        elevationMax?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    volcanoes? volcanoRadius? volcanoHeight? volcanoLavaTerrain? volcanoAshTerrain? volcanoAshRadius? volcanoSmokeLayer? elevationMax?

    Properties

    volcanoes?: number

    Number of volcanoes to raise. Default 0 (off).

    volcanoRadius?: number

    Radius of the cone in cells, rim crest to the foot of the flanks. Default 4.

    volcanoHeight?: number

    Rim height above the ground the cone is built on, in elevation steps. Default 5.

    volcanoLavaTerrain?: number

    Terrain index for the caldera pool. Should belong to a liquid type (the built-in lava is the obvious one) so the pool renders as a surface; omit for a dry crater floored with VolcanoOptions.volcanoAshTerrain.

    volcanoAshTerrain?: number

    Terrain index for the cone and the ash apron around it. Default Rock (4); pass VOLCANIC_ASH_TERRAIN_DESCRIPTOR's index for a dark ash field.

    volcanoAshRadius?: number

    How far past the foot of the cone ash falls, feathering out. Default 1.5 × radius.

    volcanoSmokeLayer?: number

    Feature layer to write smoke density into: 2 on the rim (about half its slots, at the middle and small tiers), nothing elsewhere — fumaroles, not a wall of cloud. Omit to leave every layer alone. Pair it with a scatter definition on that layer (see createSmokeGeometry).

    elevationMax?: number

    Elevation cap. Default 12.

    Settings

    Member Visibility

    On This Page

    Properties