Class: ParticleEmitter
Defined in: particles/components/particle-emitter.ts:93
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:117
Creates a new ParticleEmitter instance.
Parameters
sprite
The sprite to use for the particles.
renderLayer
number
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:105
currentlyEmitting
currentlyEmitting:
boolean
Defined in: particles/components/particle-emitter.ts:109
emitCount
emitCount:
number
Defined in: particles/components/particle-emitter.ts:106
emitDurationSeconds
emitDurationSeconds:
number
Defined in: particles/components/particle-emitter.ts:104
lifetimeScaleReduction
lifetimeScaleReduction:
number
Defined in: particles/components/particle-emitter.ts:103
lifetimeSecondsRange
lifetimeSecondsRange:
Range
Defined in: particles/components/particle-emitter.ts:102
numParticlesRange
numParticlesRange:
Range
Defined in: particles/components/particle-emitter.ts:97
renderLayer
renderLayer:
number
Defined in: particles/components/particle-emitter.ts:95
rotationRange
rotationRange:
Range
Defined in: particles/components/particle-emitter.ts:100
rotationSpeedRange
rotationSpeedRange:
Range
Defined in: particles/components/particle-emitter.ts:101
scaleRange
scaleRange:
Range
Defined in: particles/components/particle-emitter.ts:99
spawnPosition
spawnPosition:
ParticleSpawnPositionFunction
Defined in: particles/components/particle-emitter.ts:96
speedRange
speedRange:
Range
Defined in: particles/components/particle-emitter.ts:98
sprite
sprite:
Sprite
Defined in: particles/components/particle-emitter.ts:94
startEmitting
startEmitting:
boolean
Defined in: particles/components/particle-emitter.ts:108
totalAmountToEmit
totalAmountToEmit:
number
Defined in: particles/components/particle-emitter.ts:107
Methods
emit()
emit():
void
Defined in: particles/components/particle-emitter.ts:198
Starts emitting particles from the emitter immediately.
Returns
void
emitIfNotEmitting()
emitIfNotEmitting():
void
Defined in: particles/components/particle-emitter.ts:189
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:158
Sets the options for the particle emitter.
Parameters
options
Partial<ParticleEmitterOptions>
The options to configure the particle emitter.
Returns
void