threejs-worldgen
    Preparing search index...

    Interface PrecipitationProps

    Props of <Precipitation>: every PrecipitationInput setting plus the ones below.

    interface PrecipitationProps {
        ground?: ((x: number, z: number) => number) | null;
        heavyRate?: number;
        height?: number;
        maxRain?: number;
        maxSnow?: number;
        override?: PrecipitationOverride | null;
        radius?: number;
        rain?: Partial<RainLook>;
        ref?: Ref<Precipitation | null>;
        seed?: string | number;
        snow?: Partial<SnowLook>;
        splashes?: Partial<SplashLook>;
    }

    Hierarchy (View Summary)

    Index
    ground? heavyRate? height? maxRain? maxSnow? override? radius? rain? ref? seed? snow? splashes?
    ground?: ((x: number, z: number) => number) | null

    Ground height for splashes (frame coordinates). Default: the weather's world.

    heavyRate?: number

    Precipitation rate (mm/h) that shows every particle.

    height?: number

    Height of the particle box, metres.

    maxRain?: number

    Raindrops at full rain.

    maxSnow?: number

    Snowflakes at full snow.

    override?: PrecipitationOverride | null

    Fixed conditions instead of the weather (demos, cutscenes): rate in mm/h, snow share 0…1 and wind [x, z] m/s. null reads the weather at the camera.

    radius?: number

    Half-width of the particle box around the camera, metres.

    rain?: Partial<RainLook>

    Rain look to change.

    ref?: Ref<Precipitation | null>

    Receives the PrecipitationImpl instance.

    seed?: string | number

    Seed for particle placement.

    snow?: Partial<SnowLook>

    Snow look to change.

    splashes?: Partial<SplashLook>

    Splash look to change.

    Settings
    Member Visibility

    On This Page
    Properties