ParticleEmitter

For examples on how to use, refer to ParticleService.

Creates a Roblox ParticleEmitter.

Functions

setTexture(texture: string)

Sets the rbxassetid of the texture of the particle emitter.

setColor(color: ColorSequence)

Sets the color of the particles emitted.

setRate(rate: number)

Sets the rate of the particles emitted.

setPosition(position: Vector3)

Sets the position of the particle emitter.

getPosition(): Vector3

Returns the position of the particle emitter.

setRotation(rotation: Vector3)

Sets the rotation of the particle emitter.

getRotation(): Vector3

Returns the rotation of the particle emitter.

setCFrame(cframe: CFrame)

Sets the CFrame of the particle emitter.

getCFrame(): CFrame

Returns the CFrame of the particle emitter.

setRegionSize(size: Vector3)

Sets the size of the region from which particles are emitted.

getRegionSize(): Vector3

Returns the size of the region from which particles are emitted.

setSize(size: NumberSequence)

Sets the size of the particles emitted.

getSize(): NumberSequence

Returns the size of the particles emitted.

setTransparency(transparency: NumberSequence)

Sets the transparency of the particles emitted.

getTransparency(): NumberSequence

Returns the transparency of the particles emitted.

setBrightness(brightness: number)

Sets the brightness of the particles emitted.

setSpeed(speed: NumberRange)

Sets the speed of the particles emitted.

setAcceleration(acceleration: Vector3)

Sets the acceleration of the particles emitted.

setDrag(drag: number)

Sets the drag of the particles emitted.

setLifetime(lifetime: NumberRange)

Sets the lifetime of the particles emitted.

setParticleOrientation(orientation: ParticleOrientation)

Sets the particle orientation of the particles emitted. Written as ParticleOrientation.FacingCamera

setParticleRotation(rotation: NumberRange)

Sets the particle rotation of the particles emitted.

setRotSpeed(speed: NumberRange)

Sets the rotation speed of the particles emitted.

setLightInfluence(influence: number)

Sets the light influence of the particles emitted.

setLightEmission(emission: number)

Sets the light emission of the particles emitted.

setSquash(squash: NumberSequence)

Sets the squash of the particles emitted.

setSpreadAngle(angle: Vector2)

Sets the spread angle of the particles emitted.

setTimeScale(timeScale: number)

Sets the time scale of the particles emitted.

setEnabled(enabled: boolean)

Enables or disables the particle emitter.

setLockedToPart(locked: boolean)

Sets the particle emission to be locked to the emission source, or whether the particles will linger around the position they were emitted if the emission source moves.

emit(amount: number | nil)

Emits the given amount of particles, otherwise defaults to the rate of the particle emitter.

clear()

Clears any currently emitted particles.

destroy()

Destroys the particle emitter.