Class: ParticleEmitter

Defined in: particles/components/particle-emitter.ts:92

Represents a particle Emitter. This class is used to define properties and behavior for particles emitters, to configure the spawning and function of the particles.

Constructors

Constructor

new ParticleEmitter(sprite, renderLayer, options): ParticleEmitter

Defined in: particles/components/particle-emitter.ts:116

Creates a new ParticleEmitter instance.

Parameters

sprite

Sprite

The sprite to use for the particles.

renderLayer

ForgeRenderLayer

The render layer to use for the particles.

options

Partial<ParticleEmitterOptions> = {}

The options to configure the particle emitter.

Returns

ParticleEmitter

Properties

currentEmitDuration

currentEmitDuration: number

Defined in: particles/components/particle-emitter.ts:104

---

currentlyEmitting

currentlyEmitting: boolean

Defined in: particles/components/particle-emitter.ts:108

---

emitCount

emitCount: number

Defined in: particles/components/particle-emitter.ts:105

---

emitDurationSeconds

emitDurationSeconds: number

Defined in: particles/components/particle-emitter.ts:103

---

lifetimeScaleReduction

lifetimeScaleReduction: number

Defined in: particles/components/particle-emitter.ts:102

---

lifetimeSecondsRange

lifetimeSecondsRange: MinMaxRange

Defined in: particles/components/particle-emitter.ts:101

---

numParticlesRange

numParticlesRange: MinMaxRange

Defined in: particles/components/particle-emitter.ts:96

---

renderLayer

renderLayer: ForgeRenderLayer

Defined in: particles/components/particle-emitter.ts:94

---

rotationRange

rotationRange: MinMaxRange

Defined in: particles/components/particle-emitter.ts:99

---

rotationSpeedRange

rotationSpeedRange: MinMaxRange

Defined in: particles/components/particle-emitter.ts:100

---

scaleRange

scaleRange: MinMaxRange

Defined in: particles/components/particle-emitter.ts:98

---

spawnPosition

spawnPosition: ParticleSpawnPositionFunction

Defined in: particles/components/particle-emitter.ts:95

---

speedRange

speedRange: MinMaxRange

Defined in: particles/components/particle-emitter.ts:97

---

sprite

sprite: Sprite

Defined in: particles/components/particle-emitter.ts:93

---

startEmitting

startEmitting: boolean

Defined in: particles/components/particle-emitter.ts:107

---

totalAmountToEmit

totalAmountToEmit: number

Defined in: particles/components/particle-emitter.ts:106

Methods

emit()

emit(): void

Defined in: particles/components/particle-emitter.ts:197

Starts emitting particles from the emitter immediately.

Returns

void

---

emitIfNotEmitting()

emitIfNotEmitting(): void

Defined in: particles/components/particle-emitter.ts:188

Emits particles from the emitter if it is not already emitting. If already emitting, this function call does nothing.

Returns

void

---

setOptions()

setOptions(options): void

Defined in: particles/components/particle-emitter.ts:157

Sets the options for the particle emitter.

Parameters

options

Partial<ParticleEmitterOptions>

The options to configure the particle emitter.

Returns

void