EmitterOptions

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

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

Properties

alpha?

optional alpha?: NumberRange | Lerped

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

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

---

angle?

optional angle?: NumberRange

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

Emission direction in radians. Default: 0.

---

blendMode?

optional blendMode?: BLEND_MODES

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

How the whole particle container’s pixels combine with what is drawn beneath it — "add" for fire, sparks, and magic. Unset, the container inherits its render layer’s blend mode, which is "normal" unless the game set one on the layer. See BlendMode for the modes that need import "pixi.js/advanced-blend-modes".

---

damping?

optional damping?: number

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

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

---

gravity?

optional gravity?: object

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

Gravity in px/s². Default: none.

x

x: number

y

y: number

---

layer?

optional layer?: string

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

Render layer name. Default: “default”.

---

lifetime

lifetime: NumberRange

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

Particle lifetime in seconds.

---

maxParticles?

optional maxParticles?: number

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

Maximum number of live particles. Default: 100.

---

radialSpeed?

optional radialSpeed?: NumberRange

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

Speed in px/s along the direction from the emitter’s origin to the particle’s spawn offset. Negative moves inward. Adds to the velocity speed and angle produce. Needs a spawnOffset.

---

rate?

optional rate?: number

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

Particles per second for continuous emission. Default: 10.

---

rotation?

optional rotation?: NumberRange

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

Initial rotation in radians. Default: 0.

---

rotationSpeed?

optional rotationSpeed?: NumberRange

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

Rotation speed in rad/s. Default: 0.

---

scale?

optional scale?: NumberRange | Lerped

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

Uniform scale (or lerped). Default: 1.

---

simulationSpace?

optional simulationSpace?: "world" | "local"

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

"world" (default): particles keep the screen position they were spawned at, so moving the emitter afterwards does not drag them along. "local": particles follow the emitter’s position. Position only — the emitter’s rotation and scale are not applied.

---

spawnOffset?

optional spawnOffset?: { angle?: undefined; radius?: undefined; x?: NumberRange; y?: NumberRange; } | { angle?: NumberRange; radius: NumberRange; x?: undefined; y?: undefined; }

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

Random offset from the emitter’s origin at spawn time, in either form: a rectangle (x/y ranges) or a ring (radius, with an optional angle arc that defaults to the full circle). Setting members of both forms is a type error.

---

speed?

optional speed?: NumberRange

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

Initial speed in px/s. Default: 0.

---

tint?

optional tint?: number

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

Tint color. Default: 0xffffff.