PixiJS Particle System

Appearance

EmitterOptions<DataType, ParticleType> ​

ts
type EmitterOptions<DataType, ParticleType> = object;

Extra emitter options allowing for custom particles/particle data.

Type Parameters ​

DataType ​

DataType extends BaseParticleData = BaseParticleData

Type describing the data object stored on particles.

ParticleType ​

ParticleType extends IEmitterParticle<DataType> = IEmitterParticle<DataType>

Type describing the particle used within the emitter.

Properties ​

customDataInitializer()? ​

ts
optional customDataInitializer: (data) => void;

Initializes any custom data for the particles. By default, does nothing, as there is no custom data.

Parameters ​

data ​

DataType

Data used by the particle.

Returns ​

void

dataFactory()? ​

ts
optional dataFactory: () => DataType;

Creates and returns object containing particle data. By default, uses BaseParticleData object to store particle data.

Returns ​

DataType

New particle data object.

particleFactory()? ​

ts
optional particleFactory: (data) => ParticleType;

Creates and returns new instance of a particle. By default, uses EmitterParticle as the base particle class.

Parameters ​

data ​

DataType

Data used by the particle.

Returns ​

ParticleType

New particle instance.