API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

I

interfaceParticleWriter

@codexo/exojs-particles / particles / stable

A single freshly emitted particle, addressed by name. Every field starts at its default - zero position, velocity, rotation and rotation speed, unit scale, opaque white, frame 0, lifetime 1 - so a spawner writes only what it varies. The writer is a cursor onto the emitting system, not a particle object: it is reused by the next ParticleEmitter.emit call and must not be kept. Read what you need before emitting again.

8
props
0
methods
0
events
Import
import { ParticleWriter } from '@codexo/exojs-particles'

A single freshly emitted particle, addressed by name.

Every field starts at its default - zero position, velocity, rotation and rotation speed, unit scale, opaque white, frame 0, lifetime 1 - so a spawner writes only what it varies.

The writer is a cursor onto the emitting system, not a particle object: it is reused by the next ParticleEmitter.emit call and must not be kept. Read what you need before emitting again.

Properties8
color: number
Packed 0xAABBGGRR tint.
frame: number
Atlas frame index. Ignored by a system that declares no frames, and an index past the declared ones shows frame 0. Development builds throw on a negative or out-of-range value rather than letting it wrap onto a different, valid frame.
lifetime: number
Total seconds before this particle expires.
position: ParticleVectorWriterWritable two-component channel of a single particle.
rotation: number
rotationSpeed: number
scale: ParticleVectorWriterWritable two-component channel of a single particle.
velocity: ParticleVectorWriterWritable two-component channel of a single particle.
Source
packages/exojs-particles/src/ParticleStorage.ts