Skip to content

EmitterConfig

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

Emitter configuration.

optional alpha?: NumberRange | Lerped

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

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


optional angle?: NumberRange

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

Emission direction in radians. Default: 0.


optional damping?: number

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

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


optional gravity?: object

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

Gravity in px/s². Default: none.

x: number

y: number


optional layer?: string

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

Render layer name. Default: “default”.


lifetime: NumberRange

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

Particle lifetime in seconds.


optional maxParticles?: number

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

Maximum number of live particles. Default: 100.


optional rate?: number

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

Particles per second for continuous emission. Default: 10.


optional rotation?: NumberRange

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

Initial rotation in radians. Default: 0.


optional rotationSpeed?: NumberRange

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

Rotation speed in rad/s. Default: 0.


optional scale?: NumberRange | Lerped

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

Uniform scale (or lerped). Default: 1.


optional spawnOffset?: object

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

Random offset from entity position at spawn time.

optional x?: NumberRange

optional y?: NumberRange


optional speed?: NumberRange

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

Initial speed in px/s. Default: 0.


optional texture?: TextureInput

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

The texture for all particles in this emitter.


optional textureKey?: string

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

Texture asset key (serializable alternative to texture).


optional tint?: number

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

Tint color. Default: 0xffffff.