API reference

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

I

interfaceParticleSpawnFields

@codexo/exojs-particles / particles / stable

Per-property spawn configuration shared by the built-in spawners. Every entry is a Distribution sampled once per emitted particle. Omitting an entry leaves that property at its spawn default: origin, no velocity, unit scale, no rotation, opaque white, frame 0, one second of life.

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

Per-property spawn configuration shared by the built-in spawners.

Every entry is a Distribution sampled once per emitted particle. Omitting an entry leaves that property at its spawn default: origin, no velocity, unit scale, no rotation, opaque white, frame 0, one second of life.

Properties8
lifetime?: DistributionValue distribution sampled at particle spawn time. Each `sample()` call may return a different value - used to randomize spawn properties (lifetime, position,…<number>
Total lifetime in seconds. Drives expiry.
position?: DistributionValue distribution sampled at particle spawn time. Each `sample()` call may return a different value - used to randomize spawn properties (lifetime, position,…<VectorConcrete mutable 2D vector with full AbstractVector arithmetic and Collidable collision support (treated as a point collider). `Vector.temp` provides a shared…>
rotation?: DistributionValue distribution sampled at particle spawn time. Each `sample()` call may return a different value - used to randomize spawn properties (lifetime, position,…<number>
rotationSpeed?: DistributionValue distribution sampled at particle spawn time. Each `sample()` call may return a different value - used to randomize spawn properties (lifetime, position,…<number>
scale?: DistributionValue distribution sampled at particle spawn time. Each `sample()` call may return a different value - used to randomize spawn properties (lifetime, position,…<VectorConcrete mutable 2D vector with full AbstractVector arithmetic and Collidable collision support (treated as a point collider). `Vector.temp` provides a shared…>
textureIndex?: DistributionValue distribution sampled at particle spawn time. Each `sample()` call may return a different value - used to randomize spawn properties (lifetime, position,…<number>
Atlas frame index. Ignored by a system that declares no frames.
tint?: DistributionValue distribution sampled at particle spawn time. Each `sample()` call may return a different value - used to randomize spawn properties (lifetime, position,…<Color32-bit RGBA color value with channel-wise accessors. Red, green, and blue are integers in 0..255; alpha is a float in 0..1. Out-of-range values are saturated o…>
Initial tint. For a per-frame fade use a ColorOverLifetime update module.
velocity?: DistributionValue distribution sampled at particle spawn time. Each `sample()` call may return a different value - used to randomize spawn properties (lifetime, position,…<VectorConcrete mutable 2D vector with full AbstractVector arithmetic and Collidable collision support (treated as a point collider). `Vector.temp` provides a shared…>
Source
packages/exojs-particles/src/modules/spawnFields.ts