[Home](./index.md) > [server](./server.md) > [ParticleEmitter](./server.particleemitter.md) ## ParticleEmitter class Represents a particle emitter in the world. Emit 2D particles that always face the camera. **Signature:** ```typescript export default class ParticleEmitter extends EventRouter implements protocol.Serializable ``` **Extends:** [EventRouter](./server.eventrouter.md) **Implements:** protocol.Serializable ## Remarks Particle emitters are created directly as instances. They support a variety of configuration options through the [ParticleEmitterOptions](./server.particleemitteroptions.md) constructor argument.

Events

This class is an EventRouter, and instance of it emit events with payloads listed under [ParticleEmitterEventPayloads](./server.particleemittereventpayloads.md). ## Example ```typescript const particleEmitter = new ParticleEmitter({ textureUri: 'textures/particles/smoke.png', }); particleEmitter.spawn(world); ``` ## Constructors
Constructor Modifiers Description
[(constructor)(options)](./server.particleemitter._constructor_.md) Constructs a new instance of the `ParticleEmitter` class
## Properties
Property Modifiers Type Description
[alphaTest](./server.particleemitter.alphatest.md) `readonly` number \| undefined The alpha test value, discards particle texture pixels with alpha opacity less than this value.
[attachedToEntity](./server.particleemitter.attachedtoentity.md) `readonly` [Entity](./server.entity.md) \| undefined The entity to which the ParticleEmitter is attached if explicitly set.
[attachedToEntityNodeName](./server.particleemitter.attachedtoentitynodename.md) `readonly` string \| undefined The name of the node of the attached entity (if the attached entity is a model entity) to attach the particle emitter to.
[colorEnd](./server.particleemitter.colorend.md) `readonly` [RgbColor](./server.rgbcolor.md) \| undefined The color of an emitted particle at the end of its lifetime.
[colorEndVariance](./server.particleemitter.colorendvariance.md) `readonly` [RgbColor](./server.rgbcolor.md) \| undefined The color variance of an emitted particle at the end of its lifetime.
[colorStart](./server.particleemitter.colorstart.md) `readonly` [RgbColor](./server.rgbcolor.md) \| undefined The color of an emitted particle at the start of its lifetime.
[colorStartVariance](./server.particleemitter.colorstartvariance.md) `readonly` [RgbColor](./server.rgbcolor.md) \| undefined The color variance of an emitted particle at the start of its lifetime.
[gravity](./server.particleemitter.gravity.md) `readonly` [Vector3Like](./server.vector3like.md) \| undefined The gravity vector for an emitted particle.
[id](./server.particleemitter.id.md) `readonly` number \| undefined The unique identifier for the ParticlEmitter.
[isSpawned](./server.particleemitter.isspawned.md) `readonly` boolean Whether the ParticleEmitter is spawned in the world.
[isStopped](./server.particleemitter.isstopped.md) `readonly` boolean Whether the ParticleEmitter is stopped.
[lifetime](./server.particleemitter.lifetime.md) `readonly` number \| undefined The lifetime of an emitted particle in seconds.
[lifetimeVariance](./server.particleemitter.lifetimevariance.md) `readonly` number \| undefined The lifetime variance of an emitted particle in seconds.
[maxParticles](./server.particleemitter.maxparticles.md) `readonly` number \| undefined The maximum number of live particles.
[offset](./server.particleemitter.offset.md) `readonly` [Vector3Like](./server.vector3like.md) \| undefined The offset of the particle emitter from the attached entity or position.
[opacityEnd](./server.particleemitter.opacityend.md) `readonly` number \| undefined The opacity of an emitted particle at the end of its lifetime.
[opacityEndVariance](./server.particleemitter.opacityendvariance.md) `readonly` number \| undefined The opacity variance of an emitted particle at the end of its lifetime.
[opacityStart](./server.particleemitter.opacitystart.md) `readonly` number \| undefined The opacity of an emitted particle at the start of its lifetime.
[opacityStartVariance](./server.particleemitter.opacitystartvariance.md) `readonly` number \| undefined The opacity variance of an emitted particle at the start of its lifetime.
[position](./server.particleemitter.position.md) `readonly` [Vector3Like](./server.vector3like.md) \| undefined The position of the particle emitter in the world if explicitly set.
[positionVariance](./server.particleemitter.positionvariance.md) `readonly` [Vector3Like](./server.vector3like.md) \| undefined The position variance of an emitted particle.
[rate](./server.particleemitter.rate.md) `readonly` number \| undefined The rate per second at which particles are emitted.
[rateVariance](./server.particleemitter.ratevariance.md) `readonly` number \| undefined The rate per second variance of the particle emission rate.
[size](./server.particleemitter.size.md) `readonly` number \| undefined The size of an emitted particle.
[sizeVariance](./server.particleemitter.sizevariance.md) `readonly` number \| undefined The size variance of an emitted particle.
[textureUri](./server.particleemitter.textureuri.md) `readonly` string The URI or path to the texture to be used for the particles.
[transparent](./server.particleemitter.transparent.md) `readonly` boolean \| undefined Whether an emitted particle is transparent, resulting in smoother transparency blending.
[velocity](./server.particleemitter.velocity.md) `readonly` [Vector3Like](./server.vector3like.md) \| undefined The velocity of an emitted particle.
[velocityVariance](./server.particleemitter.velocityvariance.md) `readonly` [Vector3Like](./server.vector3like.md) \| undefined The velocity variance of an emitted particle.
[world](./server.particleemitter.world.md) `readonly` [World](./server.world.md) \| undefined The world the ParticleEmitter is in.
## Methods
Method Modifiers Description
[despawn()](./server.particleemitter.despawn.md) Despawns the ParticleEmitter from the world.
[restart()](./server.particleemitter.restart.md) Restarts the particle emission if it was previously stopped. Internally, this sets the rate to the value it was before being stopped.
[setAlphaTest(alphaTest)](./server.particleemitter.setalphatest.md) Sets the alpha test value, discards particle texture pixels with alpha opacity less than this value.
[setAttachedToEntity(entity)](./server.particleemitter.setattachedtoentity.md) Sets the entity to which the ParticleEmitter is attached.
[setAttachedToEntityNodeName(attachedToEntityNodeName)](./server.particleemitter.setattachedtoentitynodename.md) Sets the name of the node of the attached entity (if the attached entity is a model entity) to attach the particle emitter to.
[setColorEnd(colorEnd)](./server.particleemitter.setcolorend.md) Sets the color of an emitted particle at the end of its lifetime.
[setColorEndVariance(colorEndVariance)](./server.particleemitter.setcolorendvariance.md) Sets the color variance of an emitted particle at the end of its lifetime.
[setColorStart(colorStart)](./server.particleemitter.setcolorstart.md) Sets the color of an emitted particle at the start of its lifetime.
[setColorStartVariance(colorStartVariance)](./server.particleemitter.setcolorstartvariance.md) Sets the color variance of an emitted particle at the start of its lifetime.
[setGravity(gravity)](./server.particleemitter.setgravity.md) Sets the gravity vector for an emitted particle.
[setLifetime(lifetime)](./server.particleemitter.setlifetime.md) Sets the lifetime of an emitted particle in seconds.
[setLifetimeVariance(lifetimeVariance)](./server.particleemitter.setlifetimevariance.md) Sets the lifetime variance of an emitted particle in seconds.
[setMaxParticles(maxParticles)](./server.particleemitter.setmaxparticles.md) Sets the maximum number of live particles.
[setOffset(offset)](./server.particleemitter.setoffset.md) Sets the offset of the particle emitter from the attached entity or position.
[setOpacityEnd(opacityEnd)](./server.particleemitter.setopacityend.md) Sets the opacity of an emitted particle at the end of its lifetime.
[setOpacityEndVariance(opacityEndVariance)](./server.particleemitter.setopacityendvariance.md) Sets the opacity variance of an emitted particle at the end of its lifetime.
[setOpacityStart(opacityStart)](./server.particleemitter.setopacitystart.md) Sets the opacity of an emitted particle at the start of its lifetime.
[setOpacityStartVariance(opacityStartVariance)](./server.particleemitter.setopacitystartvariance.md) Sets the opacity variance of an emitted particle at the start of its lifetime.
[setPosition(position)](./server.particleemitter.setposition.md) Sets the position of the particle emitter.
[setPositionVariance(positionVariance)](./server.particleemitter.setpositionvariance.md) Sets the position variance of an emitted particle.
[setRate(rate)](./server.particleemitter.setrate.md) Sets the rate per second at which particles are emitted.
[setRateVariance(rateVariance)](./server.particleemitter.setratevariance.md) Sets the rate variance of the particle emission rate.
[setSize(size)](./server.particleemitter.setsize.md) Sets the size of an emitted particle.
[setSizeVariance(sizeVariance)](./server.particleemitter.setsizevariance.md) Sets the size variance of an emitted particle.
[setTextureUri(textureUri)](./server.particleemitter.settextureuri.md) Sets the texture URI of the particles emitted.
[setTransparent(transparent)](./server.particleemitter.settransparent.md) Sets the transparency of the particle emitter.
[setVelocity(velocity)](./server.particleemitter.setvelocity.md) Sets the velocity of an emitted particle.
[setVelocityVariance(velocityVariance)](./server.particleemitter.setvelocityvariance.md) Sets the velocity variance of an emitted particle.
[spawn(world)](./server.particleemitter.spawn.md) Spawns the ParticleEmitter in the world.
[stop()](./server.particleemitter.stop.md) Stops the particle emission if it was previously started. Internally, this sets the rate to 0.