Skip to content

EmitterOptions

Defined in: particles/src/types.ts:32

Everything an emitter configures apart from where its texture comes from.

optional alpha?: NumberRange | Lerped

Defined in: particles/src/types.ts:46

Alpha/opacity (or lerped). Default: 1.


optional angle?: NumberRange

Defined in: particles/src/types.ts:42

Emission direction in radians. Default: 0.


optional blendMode?: BLEND_MODES

Defined in: particles/src/types.ts:59

How the whole particle container’s pixels combine with what is drawn beneath it — "add" for fire, sparks, and magic. Default: "normal". See BlendMode for the modes that need import "pixi.js/advanced-blend-modes".


optional damping?: number

Defined in: particles/src/types.ts:63

Velocity damping per second (0-1). Default: 0.


optional gravity?: object

Defined in: particles/src/types.ts:61

Gravity in px/s². Default: none.

x: number

y: number


optional layer?: string

Defined in: particles/src/types.ts:70

Render layer name. Default: “default”.


lifetime: NumberRange

Defined in: particles/src/types.ts:38

Particle lifetime in seconds.


optional maxParticles?: number

Defined in: particles/src/types.ts:34

Maximum number of live particles. Default: 100.


optional rate?: number

Defined in: particles/src/types.ts:36

Particles per second for continuous emission. Default: 10.


optional rotation?: NumberRange

Defined in: particles/src/types.ts:48

Initial rotation in radians. Default: 0.


optional rotationSpeed?: NumberRange

Defined in: particles/src/types.ts:50

Rotation speed in rad/s. Default: 0.


optional scale?: NumberRange | Lerped

Defined in: particles/src/types.ts:44

Uniform scale (or lerped). Default: 1.


optional spawnOffset?: object

Defined in: particles/src/types.ts:65

Random offset from entity position at spawn time.

optional x?: NumberRange

optional y?: NumberRange


optional speed?: NumberRange

Defined in: particles/src/types.ts:40

Initial speed in px/s. Default: 0.


optional tint?: number

Defined in: particles/src/types.ts:52

Tint color. Default: 0xffffff.