hex-world
    Preparing search index...

    Interface WindSwayOptions

    How a given plant answers the wind. Unset fields keep their current value.

    interface WindSwayOptions {
        enabled?: boolean;
        amplitude?: number;
        stiffness?: number;
        height?: number;
        flutter?: number;
    }
    Index

    Properties

    enabled?: boolean

    Whether this material sways at all. Default true.

    amplitude?: number

    Tip displacement at full wind as a fraction of height — so it means the same thing on a sapling and on an old oak. Default 0.065.

    Low on purpose. A plant's silhouette is what the eye tracks, and past roughly a tenth of its height the bend stops reading as wind and starts reading as rubber.

    stiffness?: number

    How the bend is distributed up the plant: 1 bows evenly from the base, 2 keeps the trunk stiff and moves the crown, 4 flicks only the tip. Default 2.

    height?: number

    The plant's overall height in world units — what amplitude is a fraction of, and the height at which the bend reaches full. Default 2.

    flutter?: number

    Sideways shiver across the wind, as a fraction of the downwind bend. Default 0.35.