hex-world
    Preparing search index...

    Interface WaterfallSprayMaterialOptions

    Tuning for the waterfall spray particle animation.

    interface WaterfallSprayMaterialOptions {
        shallow?: Color;
        deep?: Color;
        foam?: Color;
        opacity?: number;
        flowSpeed?: number;
        emissive?: Color;
        emissiveStrength?: number;
        waveScale?: number;
        foamIntensity?: number;
        freezePoint?: number;
        freezeBand?: number;
        iceColor?: Color;
        iceOpacity?: number;
        rate?: number;
        rise?: number;
        sway?: number;
        arc?: number;
        drift?: number;
        size?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    shallow? deep? foam? opacity? flowSpeed? emissive? emissiveStrength? waveScale? foamIntensity? freezePoint? freezeBand? iceColor? iceOpacity? rate? rise? sway? arc? drift? size?

    Properties

    shallow?: Color

    Shallow-water / surface liquid color. Default: blue-green water.

    deep?: Color

    Deep-water color (surface material only). Default: dark blue.

    foam?: Color

    Foam / crest color (shore and estuary materials). Default: near-white.

    opacity?: number

    Surface alpha 0–1. Default 0.82 (0.78 for the river material).

    flowSpeed?: number

    Animation time multiplier for waves/foam/flow. Default 1.

    emissive?: Color

    Self-illumination color, scaled by emissiveStrength. Default black.

    emissiveStrength?: number

    Emissive intensity; only partially dimmed by fog-of-war. Default 0.

    waveScale?: number

    Surface-noise frequency multiplier. Default 1.

    foamIntensity?: number

    Shore/estuary foam intensity multiplier. Default 1.

    freezePoint?: number

    Season-adjusted temperature at or below which this liquid freezes, on the generator's 0–1 scale. Undefined means it never freezes — see LiquidTypeDescriptor.freezePoint.

    freezeBand?: number

    Width of the transition around LiquidColorOptions.freezePoint. Default 0.06.

    iceColor?: Color

    Color a frozen surface blends toward. Default a pale blue-white.

    iceOpacity?: number

    Surface alpha once fully frozen. Higher than LiquidColorOptions.opacity on purpose — ice you can see straight through reads as water that stopped moving. Default 0.97.

    rate?: number

    Particle lifetime cycles per second (before flowSpeed). Default 0.9.

    rise?: number

    How far a puff climbs (or, at arc 1, how high it is thrown), world units. Default 0.75.

    sway?: number

    Turbulent horizontal wander amplitude, world units. Default 0.13.

    arc?: number

    Rises-vs-thrown, 0–1. See LiquidTypeDescriptor.sprayArc. Default 0.

    drift?: number

    Downstream drift over a particle's life, world units. Default 0.55.

    size?: number

    Base point size in pixels at 110 world units of depth (attenuation is clamped at 6×, so this is not the on-screen size up close). Default 3.5.

    Settings

    Member Visibility

    On This Page

    Properties