Atlas Engine
API Referenceatlasatlas/particle

ParticleSettings

Lifetime, size, fading, gravity, spread, and speed variation for emitted particles.

Module: atlas/particle

Lifetime, size, fading, gravity, spread, and speed variation for emitted particles.

Declaration

export type ParticleSettings = {
        /**
         * The minimum lifetime.
         */
        minLifetime: number;
        /**
         * The particle's total lifetime, in seconds.
         */
        maxLifetime: number;
        /**
         * The minimum size.
         */
        minSize: number;
        /**
         * The maximum size.
         */
        maxSize: number;
        /**
         * The fade speed.
         */
        fadeSpeed: number;
        /**
         * The gravitational acceleration applied by the simulation.
         */
        gravity: number;
        /**
         * The spread.
         */
        spread: number;
        /**
         * The speed variation.
         */
        speedVariation: number;
    };

Properties

minLifetime

The minimum lifetime.

minLifetime: number;

maxLifetime

The particle's total lifetime, in seconds.

maxLifetime: number;

minSize

The minimum size.

minSize: number;

maxSize

The maximum size.

maxSize: number;

fadeSpeed

The fade speed.

fadeSpeed: number;

gravity

The gravitational acceleration applied by the simulation.

gravity: number;

spread

The spread.

spread: number;

speedVariation

The speed variation.

speedVariation: number;

On this page