hex-world
    Preparing search index...

    Interface LiquidColorOptions

    Per-liquid color and appearance options for the four liquid material factories.

    interface LiquidColorOptions {
        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;
    }

    Hierarchy (View Summary)

    Index

    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.