This function allows the developer to schedule the removal of the object without yielding any code.
Registers a given
Instance to the
Debris service for removal after the specified delay. The first argument is the object being removed, and the second argument is the amount of time in seconds the
Debris service will wait before removing the object. The delay argument is optional, if it is not specified, it defaults to 10 seconds. The delay argument is a number, so it accepts decimal points, such as ‘1.5’, or ‘0.25’.
Why use Debris?
Beyond creating a bit of a mess, objects that are no longer required can use up system memory and cause the game to run slower over time. For this reason it is always advised to run the
Instance/Destroy function on objects you no longer need. However in many cases an object may have a specific period of utility after which it needs to be destroyed.
Take the example of projectile that has just been thrown. On first thought, it could be cleaned up using:
However there are a number of issues with this approach. Firstly, it requires yielding the code with a wait, which is not always desirable. Secondly, before the 3 seconds have elapsed the object may have already been destroyed (for example, if it reached
Workspace/FallenPartsDestroyHeight). In this case, the code would error as it tries to destroy an item that has already been destroyed. One answer may be:
delay(3, function() if projectile and projectile.Parent then projectile:Destroy() end end)
This solves the above issues, as it spawns a new thread to prevent the current one from yielding and checks to see if it can be destroyed. However at this point a simple command has already become quite complicated and an unnecessary thread is being created.
This is where Debris comes in, and the following code addresses all of the above issues.
Debris does not yield the current thread, does not require a new thread and will not error if the object is already destroyed. For this reason it is the recommended method for cleaning up objects with a fixed lifetime.
The number of seconds before the
Creates parts on a loop and parents them to the Workspace, then uses Debris.AddItem to clean them up.