Debris
Allows scheduling the guaranteed destruction of an object without yielding.
.
Memory category | Instances |
---|
Member index 4
Description
The Debris service allows scheduling guaranteed destruction of an object without yielding.
Advantages
Besides creating a bit of a mess, objects that are no longer required can use up system memory and cause an experience to run slower over time. For this reason, it's always advised to call Instance:Destroy() on objects you no longer need. In some cases, however, an object may have a specific period of utility before it can be destroyed.
Consider a wall being smashed into individual bricks. If you want a brick to linger for 3 seconds before being destroyed, you can use the following code:
1 2 |
|
However, waiting causes the thread to yield which may be undesired. To avoid yielding, a callback function can be scheduled to run on a new thread after 3 seconds:
1 2 3 |
|
Or in one line:
1
|
|
While this now avoids yielding, it has a potential drawback in that the scheduled callback will never run if the script is disabled or destroyed before the callback runs.
This is where Debris has a specific advantage, as it does not yield the current thread and runs outside the context of the script, guaranteeing the instance is eventually destroyed even if the script is disabled or destroyed. The following code does not yield and guarantees the instance will be destroyed:
1
|
|
Note that Debris has a hardcoded maximum of 1,000 objects, so if more than 1,000 items are added, the oldest debris will be destroyed instantly to make room for new debris.
History 14
- 573 Change ReturnType of addItem from void to null
- 573 Change ReturnType of SetLegacyMaxItems from void to null
- 573 Change ReturnType of AddItem from void to null
- 553 Change Default of MaxItems from to
- 486 Change ThreadSafety of MaxItems from ReadOnly to ReadSafe
- 462 Change ThreadSafety of addItem from to Unsafe
- 462 Change ThreadSafety of SetLegacyMaxItems from to Unsafe
- 462 Change ThreadSafety of AddItem from to Unsafe
- 462 Change ThreadSafety of MaxItems from to ReadOnly
- 47 Add addItem
- 47 Add SetLegacyMaxItems
- 47 Add AddItem
- 47 Add MaxItems
- 47 Add Debris
Members 4
AddItem
Parameters (2) | Default | |
---|---|---|
item | Instance | |
lifetime | double | 10 |
Returns (1) | ||
null |
Schedules a given Instance for destruction within the specified
lifetime. After the lifetime
argument has elapsed, the object is
destroyed in the same manner as Instance:Destroy(). Note that the
lifetime
argument is optional and defaults to 10 seconds.
Note that Debris has a hardcoded maximum of 1,000 objects, so if
more than 1,000 items are added, the oldest debris will be destroyed
instantly to make room for new debris. This means you should treat the
lifetime
parameter as a maximum lifetime, not an exact lifetime.
Thread safety | Unsafe |
---|
MaxItems
Type | Default | |
---|---|---|
int |
The maximum number of items that can be assigned to the Debris service at one time.
If this number is exceeded, objects are automatically destroyed in order from oldest to newest until the amount is less than or equal to MaxItems.
This property is currently restricted and will error if set. The value is hardcoded to 1,000 items.
Thread safety | ReadSafe |
---|---|
Category | Data |
Loaded/Saved | true |
SetLegacyMaxItems
Parameters (1) | ||
---|---|---|
enabled | bool | |
Returns (1) | ||
null |
Security | LocalUserSecurity |
---|---|
Thread safety | Unsafe |
History 3
- 573 Change ReturnType of SetLegacyMaxItems from void to null
- 462 Change ThreadSafety of SetLegacyMaxItems from to Unsafe
- 47 Add SetLegacyMaxItems
addItem
Parameters (2) | Default | |
---|---|---|
item | Instance | |
lifetime | double | 10 |
Returns (1) | ||
null |
Thread safety | Unsafe |
---|