Class ParticleEmitter

Creates and manages a pool of Particle instances.

Example

const emitter = new ParticleEmitter(rapid, { ... });
emitter.start();

// inside your game loop:
emitter.update(dt);
emitter.render();

Index

Constructors

constructor

new ParticleEmitter(rapid: Rapid, options: IParticleOptions): ParticleEmitter
Creates a new particle emitter.
Parameters
- rapid: Rapid
  The Rapid renderer instance
- options: IParticleOptions
  Emitter configuration options
Returns ParticleEmitter
- Defined in particle.ts:242

Properties

animations

animations: {
    color: ParticleAttributeStore;
    rotation: ParticleAttributeStore;
    scale: ParticleAttributeStore;
    speed: ParticleAttributeStore;
    velocity: ParticleAttributeStore;
} = ...

color

color: DynamicArrayBuffer = ...

count

count: number = 0

localSpace

localSpace: boolean = DEFAULT_LOCAL_SPACE

Whether spawned particles are positioned in local emitter space (default: true).

rotation

rotation: DynamicArrayBuffer = ...

scaleX

scaleX: DynamicArrayBuffer = ...

scaleY

scaleY: DynamicArrayBuffer = ...

x

x: DynamicArrayBuffer = ...

y

y: DynamicArrayBuffer = ...

Methods

clear

clear(): void
Removes all particles and resets timers.

Returns void
- Defined in particle.ts:297

clone

clone(): ParticleEmitter
Creates a new emitter sharing the same options object. Particle state is NOT copied.

Returns ParticleEmitter
- Defined in particle.ts:271

createParticle

createParticle(): void
Returns void
- Defined in particle.ts:317

emit

emit(count: number): void
Spawns count particles immediately. Respects maxParticles if set.
Parameters
- count: number
Returns void
- Defined in particle.ts:309

getAllArrayBuffer

getAllArrayBuffer(): DynamicArrayBuffer[]
Returns DynamicArrayBuffer[]
- Defined in particle.ts:250

isActive

isActive(): boolean
Returns true if the emitter is running or still has live particles.

Returns boolean
- Defined in particle.ts:460

oneShot

oneShot(): void
Convenience: emit emitRate particles in one shot (fire-and-forget burst).

Returns void
- Defined in particle.ts:467

render

render(): void
Renders all live particles. In local-space mode the emitter's own transform is applied around the batch.

Returns void
- Defined in particle.ts:435

setEmitRate

setEmitRate(rate: number): void
Sets particles-per-second emission rate (continuous mode).
Parameters
- rate: number
Returns void
- Defined in particle.ts:276

setEmitTime

setEmitTime(time: number): void
Sets the burst interval in seconds (0 = continuous).
Parameters
- time: number
Returns void
- Defined in particle.ts:281

setTexture

setTexture(texture: Texture): void
Replaces the emitter's texture at runtime.
Parameters
- texture: Texture
Returns void
- Defined in particle.ts:263

start

start(): void
Starts continuous particle emission.

Returns void
- Defined in particle.ts:286

stop

stop(): void
Stops new particle emission; existing particles finish their lifecycle.

Returns void
- Defined in particle.ts:292

update

update(deltaTime: number): void
Updates the emitter and all live particles.
Parameters
- deltaTime: number
  Seconds elapsed since last frame
Returns void
- Defined in particle.ts:377

updateParticle

updateParticle(deltaTime: number): number[]
Parameters
- deltaTime: number
Returns number[]
- Defined in particle.ts:403

Class ParticleEmitter

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ParticleEmitter

Properties

animations

color

count

localSpace

rotation

scaleX

scaleY

x

y

Methods

clear

Returns void

clone

Returns ParticleEmitter

createParticle

Returns void

emit

Parameters

Returns void

getAllArrayBuffer

Returns DynamicArrayBuffer[]

isActive

Returns boolean

oneShot

Returns void

render

Returns void

setEmitRate

Parameters

Returns void

setEmitTime

Parameters

Returns void

setTexture

Parameters

Returns void

start

Returns void

stop

Returns void

update

Parameters

Returns void

updateParticle

Parameters

Returns number[]

Settings

On This Page