Clear

Unsafe

For thread safety, this property is not safe to read in an unsynchronized thread.

Function of:

Description:

The Clear method will instantly destroy any existing particles that have been emit by the ParticleEmitter via its natural emission (nonzero ParticleEmitter/Rate on an ParticleEmitter/Enabled emitter) or via ParticleEmitter/Emit. It is not possible to clear individual particles - all are deleted at once.

Sometimes it is desirable to clear particles before teleporting a character so that there are no lingering effects that might follow due to ParticleEmitter/LockedToPart.

Returns

Return Type	Summary
Return Type void	Summary

Code Samples

ParticleEmitter Burst

This code sample causes a ParticleEmitter to ParticleEmitter/Emit particles in bursts of 10 every 2 seconds. It ParticleEmitter/Clears any existing particles before doing so.

			
				ParticleEmitter Burst

				Expected Output
			
				Expand
				
			local emitter = script.Parent
while true do
	emitter:Clear()
	emitter:Emit(10)
	wait(2)
end
		
			When run, the script should emit a burst of 10 particles every 10 seconds, clearing before each new emission.
		
				Copy Code
			
				Light Theme

Clear

Returns

void

Code Samples

ParticleEmitter Burst