Skip to content

EmitterConfig

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

Emitter configuration.

optional alpha?: NumberRange | Lerped

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

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


optional angle?: NumberRange

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

Emission direction in radians. Default: 0.


optional damping?: number

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

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


optional gravity?: object

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

Gravity in px/s². Default: none.

x: number

y: number


optional layer?: string

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

Render layer name. Default: “default”.


lifetime: NumberRange

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

Particle lifetime in seconds.


optional maxParticles?: number

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

Maximum number of live particles. Default: 100.


optional rate?: number

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

Particles per second for continuous emission. Default: 10.


optional rotation?: NumberRange

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

Initial rotation in radians. Default: 0.


optional rotationSpeed?: NumberRange

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

Rotation speed in rad/s. Default: 0.


optional scale?: NumberRange | Lerped

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

Uniform scale (or lerped). Default: 1.


optional spawnOffset?: object

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

Random offset from entity position at spawn time.

optional x?: NumberRange

optional y?: NumberRange


optional speed?: NumberRange

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

Initial speed in px/s. Default: 0.


optional texture?: TextureInput

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

The texture for all particles in this emitter.


optional textureKey?: string

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

Texture asset key (serializable alternative to texture).


optional tint?: number

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

Tint color. Default: 0xffffff.