Interface IEmitter

Particles emitter object options [[include:Options/Plugins/Emitters.md]]

interface IEmitter {
    autoPlay: boolean;
    direction?:
        | number
        | "none"
        | "left"
        | "top"
        | "bottom"
        | "right"
        | "outside"
        | "inside"
        | MoveDirectionAlt
        | MoveDirection
        | "bottomLeft"
        | "bottomRight"
        | "topLeft"
        | "topRight";
    domId?: string;
    fill: boolean;
    life: IEmitterLife;
    name?: string;
    particles?: SingleOrMultiple<RecursivePartial<IParticlesOptions>>;
    position?: RecursivePartial<IRangedCoordinates>;
    rate: IEmitterRate;
    shape: IEmitterShape;
    size?: IEmitterSize;
    spawnColor?: IAnimatableColor;
    startCount: number;
}

Implemented by

Properties

autoPlay direction? domId? fill life name? particles? position? rate shape size? spawnColor? startCount

Properties

autoPlay

autoPlay: boolean

Starts the emitter automatically

Optionaldirection

direction?:
    | number
    | "none"
    | "left"
    | "top"
    | "bottom"
    | "right"
    | "outside"
    | "inside"
    | MoveDirectionAlt
    | MoveDirection
    | "bottomLeft"
    | "bottomRight"
    | "topLeft"
    | "topRight"

The direction of the emitted particles, MoveDirection is the enum used for values

OptionaldomId

domId?: string

Using this id to link the emitter to an HTML element

fill

fill: boolean

Sets if the particles will spawn at the emitter perimeter or inside the area

life

life: IEmitterLife

The emitter life options

Optionalname

name?: string

The emitter name

Optionalparticles

particles?: SingleOrMultiple<RecursivePartial<IParticlesOptions>>

Particles emitted customization. These settings will overrides other particles settings for the particles emitted by this emitter Particles number options won't override anything, they will be ignored completely

Optionalposition

position?: RecursivePartial<IRangedCoordinates>

The relative position (in percent) of the emitter, where particles spawns. If size is specified the position will be the center of the size options

rate

rate: IEmitterRate

The particles emitting rate options

shape

shape: IEmitterShape

The emitter shape type (circle or square)

Optionalsize

size?: IEmitterSize

The size of the particles emitter area

OptionalspawnColor

spawnColor?: IAnimatableColor

The particle spawn color

startCount

startCount: number

The number of starting particles of the emitter

Settings

Member Visibility

On This Page

Properties