hex-world
    Preparing search index...

    Interface ScatterMaterialDescriptor

    interface ScatterMaterialDescriptor {
        color?: number;
        vertexColors?: boolean;
        opacity?: number;
        doubleSide?: boolean;
        flatShading?: boolean;
        windSway?: boolean | WindSwayOptions;
        seasonalTint?:
            | boolean
            | {
                summer?: number;
                variance?: number;
                blossomShare?: number;
                select?: number;
                strength?: number;
            };
        snow?: boolean;
        scatterTexture?: number;
        scatterTextureScale?: number;
        rock?: boolean;
    }
    Index

    Properties

    color? vertexColors? opacity? doubleSide? flatShading? windSway? seasonalTint? snow? scatterTexture? scatterTextureScale? rock?

    Properties

    color?: number

    Flat colour, used only when vertexColors is off.

    vertexColors?: boolean

    Take colour from the geometry's vertex colours. Default true for shapes, false for models.

    opacity?: number

    Below 1 the material is transparent and stops writing depth (smoke, mist). Default 1.

    doubleSide?: boolean

    Render both faces — fronds and any single-sided plane need it. Default false.

    flatShading?: boolean

    Faceted shading. Default true.

    windSway?: boolean | WindSwayOptions

    Bend in the wind (attachWindSway). true for the defaults, an object to tune. Default false.

    seasonalTint?:
        | boolean
        | {
            summer?: number;
            variance?: number;
            blossomShare?: number;
            select?: number;
            strength?: number;
        }

    Turn with the seasons (attachSeasonalTint). true takes the recipe's canopy colour as the summer reference; an object can override it and tune the spread, blossom share, and the colour test. Default false.

    snow?: boolean

    Catch snow. Default true; false keeps a smoke plume or a lantern bare.

    scatterTexture?: number

    Fine brightness mottling (attachScatterTexture), 0–1. Default 0 = off.

    scatterTextureScale?: number

    Mottling frequency — coarser for one smooth cone, finer for small lobes. Default the attach call's.

    rock?: boolean

    Use the strata-banded rock material instead of a plain Lambert. Default false.

    Settings

    Member Visibility

    On This Page

    Properties