Class Emitter

Emitters

key option type example notes
direction string "none"
"top"
"top-right"
"right"
"bottom-right"
"bottom"
"bottom-left"
"left"
"top-left"		 The generated particles direction
life.count number 1 The emitter number of times will appear
life.duration number 5 The emitter life duration, in seconds
life.delay number 0.1 The emitter delay between any appearance
particles object See Particles options here {@link IParticlesOptions}
position object { "x": 50, "y": 50 } The position specified is not absolute, it will be used as a percent value of the canvas size.
size.width number 10
size.height number 10
size.mode string "precise" / "percent" Specify how to use the size values, precise uses pixels, percent will be calculated on canvas size
rate.quantity number 1 The particles generated everytime the rate event occurs
rate.delay number 0.1 The rate event event delay time, in seconds

Implements

Constructors

constructor

Properties

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

Methods

load

Constructors

constructor

Properties

autoPlay

autoPlay: boolean

Starts the emitter automatically

Optional direction

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

Optional domId

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: EmitterLife

The emitter life options

Optional name

name?: string

The emitter name

Optional particles

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

Optional position

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: EmitterRate

The particles emitting rate options

shape

shape: EmitterShape

The emitter shape type (circle or square)

Optional size

size?: EmitterSize

The size of the particles emitter area

Optional spawnColor

spawnColor?: AnimatableColor

The particle spawn color

startCount

startCount: number

The number of starting particles of the emitter

Methods

load

Settings

Member Visibility

Theme

On This Page