Skip to content

Methods

Getting Started

All information for each function will be explained here.

Methods

Collect.new() (Constructor)

1
2
3
local Collect = require(somewhere.Collect)

local garbage = Collect.new()

Creates a new CollectComponent instance

@return: New CollectComponent for managing cleanup tasks

Collect:Add()

1
2
3
4
5
local Collect = require(somewhere.Collect)

local garbage = Collect.new()

garbage:Add(workspace.Baseplate)

Adds an item to be tracked and cleaned up later

@param object: Item to track (function, connection, instance, thread, or table with cleanup method)

Collect:Remove()

1
2
3
4
5
local Collect = require(somewhere.Collect)

local garbage = Collect.new()

garbage:Remove(workspace.Baseplate)

Removes a specific item from tracking

  • @param object: Item to remove
  • @param clean (optional default true) : If true, calls cleanup on the item

Collect:Find()

1
2
3
4
5
6
7
local Collect = require(somewhere.Collect)

local garbage = Collect.new()

garbage:Add(workspace.Baseplate)

local myBaseplate = garbage:Find(workspace.Baseplate) --> this will return the object

Finds an item in the tracked list

  • @param object: Item to find
  • @return: The item if found, nil otherwise

Collect:RemoveAll()

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
local Collect = require(somewhere.Collect)

local garbage = Collect.new()

garbage:Add(workspace.Baseplate)
garbage:Add(workspace.Baseplate.Changed:Connect(yourCallback))

garbage:Add(function()
    print("cleaning")
end)

garbage:RemoveAll()

Removes all tracked items

  • @param clean (optional default true) : If true, calls cleanup on all items
  • @param ...: Additional arguments passed to cleanup methods

Collect:IsEmpty()

1
local isEmpty = Component:IsEmpty()

Check if current list of tasks is empty @return: True if the component has no tasks, false otherwise

Collect:LinkToInstance()

1
self = Component:LinkToInstance(Instance)

Transfer the current life cycle of the component to the new object. for example if the object is destroyed the component will also be destroyed.

Collect:Construct()

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
local Collect = require(somewhere.Collect)

local constructor = {
    new = function()
        return {
            Destroy = function()
                print("cleaning")
            end
        }
    end
}

local garbage = Collect.new()

garbage:Construct(constructor)

Creates a new object and adds it to tracking

  • @param class: Class constructor (table with .new or function)
  • @param ...: Arguments for constructor
  • @return: The created object

Collect:Extend()

1
2
3
4
5
6
7
local Collect = require(somewhere.Collect)

local garbage = Collect.new()

local extended_garbage = garbage:Extend()

garbage:Clean() --> will clean "extended_garbage" too

Creates a new CollectComponent as a child of this one

  • @return: New CollectComponent that will be cleaned with parent

Collect:Merge()

1
2
3
4
5
6
7
8
local Collect = require(somewhere.Collect)

local garbage = Collect.new()
local other_garbage = Collect.new()

other_garbage:Add(workspace.Baseplat)

garbage:Merge(other_garbage) --> merge all current tasks in "other_garbage" in this one

Merges another CollectComponent into this one, taking ownership of all its tracked items

The source component is destroyed after merging

  • @param self: Target CollectComponent that will receive the items
  • @param CollectComponent: Source CollectComponent to merge from (will be destroyed)

Collect:Clean()

1
2
3
4
5
local Collect = require(somewhere.Collect)

local garbage = Collect.new()

garbage:Clean() --> clean everything and the component itself

Cleans up all tracked items and destroys the component

This is the main cleanup method - call when done with the component

Collect:WrapClean()

1
2
3
4
5
6
7
local Collect = require(somewhere.Collect)

local garbage = Collect.new()

local clean = garbage:WrapClean() 

clean() --> clean everything and the component itself

Returns a function that cleans this component when called

Useful for passing cleanup to other systems

  • @return: Function that calls Clean()

Alias

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
-- Create alias for Constructor methods
Constructor.New = Constructor.new

-- Create alias for Component methods
Component.add = Component.Add
Component.remove = Component.Remove
Component.removeAll = Component.RemoveAll
Component.find = Component.Find
Component.construct = Component.Construct
Component.extend = Component.Extend
Component.merge = Component.Merge
Component.clean = Component.Clean
Component.destroy = Component.Clean
Component.Destroy = Component.Clean
Component.wrapClean = Component.WrapClean
Component.isEmpty = Component.IsEmpty
Component.link = Component.LinkToInstance