threejs-worldgen
    Preparing search index...

    Interface WeatherProps

    Props of <Weather>: every WeatherInput setting plus the ones below.

    interface WeatherProps {
        children?: ReactNode;
        climate?: DeepPartial<{ moisture: number; temperature: number }>;
        field?: StateField | Partial<StateFieldOptions> | null;
        fieldBudget?: number;
        fog?: DeepPartial<FogSettings>;
        followCamera?: boolean;
        fronts?: DeepPartial<FrontSettings>;
        origin?: readonly number[];
        precipitation?: DeepPartial<RainSettings>;
        ref?: Ref<Weather | null>;
        seed?: string | number;
        startTime?: number;
        storms?: DeepPartial<StormSettings>;
        surface?: DeepPartial<SurfaceSettings>;
        temperatureOffset?: number;
        time?: number;
        timeScale?: number;
        wind?: DeepPartial<WindSettings>;
        world?: World | null;
    }

    Hierarchy (View Summary)

    Index
    children? climate? field? fieldBudget? fog? followCamera? fronts? origin? precipitation? ref? seed? startTime? storms? surface? temperatureOffset? time? timeScale? wind? world?
    children?: ReactNode

    Weather-driven children (<Precipitation>, <Lightning>, <Wildfire>, …).

    climate?: DeepPartial<{ moisture: number; temperature: number }>

    Climate used when there is no world.

    field?: StateField | Partial<StateFieldOptions> | null

    A state field (or its options) to fill with wetness and snow from the weather.

    fieldBudget?: number

    Milliseconds per frame spent updating the field.

    fog?: DeepPartial<FogSettings>

    Fog.

    followCamera?: boolean

    Keep the field centred on the camera.

    fronts?: DeepPartial<FrontSettings>

    Fronts and clouds.

    origin?: readonly number[]

    Frame position at render-space zero [x, y, z] (floating origin).

    precipitation?: DeepPartial<RainSettings>

    Rain and snow.

    ref?: Ref<Weather | null>

    Receives the WeatherImpl instance.

    seed?: string | number

    Seed: the same seed, world and time always give the same weather.

    startTime?: number

    Starting time when uncontrolled, seconds.

    storms?: DeepPartial<StormSettings>

    Thunderstorms and lightning.

    surface?: DeepPartial<SurfaceSettings>

    Accumulation on the ground.

    temperatureOffset?: number

    Added to every temperature, °C (drive seasons or a day/night cycle with it).

    time?: number

    Controlled time, seconds. Omit to let the clock run at timeScale.

    timeScale?: number

    Weather seconds per real second when uncontrolled (3600 = an hour per second).

    wind?: DeepPartial<WindSettings>

    Wind.

    world?: World | null

    World whose climate drives the weather.

    Settings
    Member Visibility

    On This Page
    Properties