Small World Engine API Reference - v0.78.00
    Preparing search index...

    Interface WeatherEmitterOptions

    interface WeatherEmitterOptions {
        center?: Vector3D;
        count?: number;
        fallSpeed?: [number, number];
        geometry?: GeometryDataInterface;
        material?: AbstractMaterial;
        particleSize?: [number, number];
        spawnArea: WeatherEmitterSpawnArea;
        tumble?: boolean;
        wind?: Vector3D;
        windGustiness?: number;
    }
    Index
    center? count? fallSpeed? geometry? material? particleSize? spawnArea tumble? wind? windGustiness?
    center?: Vector3D

    Center of the spawn box. Defaults to the origin.

    count?: number

    Fixed particle pool size. Defaults to 400.

    fallSpeed?: [number, number]

    [min, max] fall speed in units/second, randomized per particle. Defaults to [0.6, 1.4].

    geometry?: GeometryDataInterface

    Instanced geometry, shared by every particle. Defaults to a small low-poly sphere (ash flake).

    material?: AbstractMaterial

    Instanced material, shared by every particle. Defaults to a pale, faintly emissive grey-green.

    particleSize?: [number, number]

    [min, max] uniform particle scale. Defaults to [0.04, 0.1].

    spawnArea: WeatherEmitterSpawnArea

    Box within which particles fall and drift.

    tumble?: boolean

    Randomizes per-particle rotation and lets it tumble slowly as it falls. Defaults to true.

    wind?: Vector3D

    Constant horizontal drift (Y component ignored). Defaults to zero.

    windGustiness?: number

    Sinusoidal wind amplitude added on top of wind, phase-shifted per particle. Defaults to 0.

    Settings
    Member Visibility

    On This Page
    Properties