Skip to main content

TrackedCleaner

The TrackedCleaner class allows for real time tracking and cleaning of variables.

Functions​

new​

</>
TrackedCleaner.new() → TrackedCleaner

Creates a new TrackedCleaner object.

Add​

</>
TrackedCleaner:Add(
item: any--

The item to add to the tracker.

) → TrackedCleaner

Add an item to the tracker.

local TrackedCleaner = require(game:GetService("ReplicatedStorage"):WaitForChild("Commons")).Cleaner.TrackedCleaner
local MyCleaner = TrackedCleaner.new()

MyCleaner:Add(workspace.MyPart)

local MyTable = {
	workspace.MyOtherPart
}

MyCleaner:Add(MyTable)

Remove​

</>
TrackedCleaner:Remove(
item: any--

The item to remove from the tracker.

) → TrackedCleaner

Remove an item from the tracker.

local TrackedCleaner = require(game:GetService("ReplicatedStorage"):WaitForChild("Commons")).Cleaner.TrackedCleaner
local MyCleaner = TrackedCleaner.new()

MyCleaner:Add(workspace.MyPart)

MyCleaner:Remove(workspace.MyPart)

Destroy​

</>
TrackedCleaner:Destroy() → ()

Destroy the tracker, and cleanup everything inside it.

local TrackedCleaner = require(game:GetService("ReplicatedStorage"):WaitForChild("Commons")).Cleaner.TrackedCleaner
local MyCleaner = TrackedCleaner.new()

MyCleaner:Add(workspace.MyPart)

MyCleaner:Destroy() -- workspace.MyPart is destroyed, as it is being tracked by the cleaner.
Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new TrackedCleaner object.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "TrackedCleaner"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 107,
                "path": "src/Commons/Cleaner.luau"
            }
        },
        {
            "name": "Add",
            "desc": "Add an item to the tracker.\n\n```lua\nlocal TrackedCleaner = require(game:GetService(\"ReplicatedStorage\"):WaitForChild(\"Commons\")).Cleaner.TrackedCleaner\nlocal MyCleaner = TrackedCleaner.new()\n\nMyCleaner:Add(workspace.MyPart)\n\nlocal MyTable = {\n\tworkspace.MyOtherPart\n}\n\nMyCleaner:Add(MyTable)\n```",
            "params": [
                {
                    "name": "item",
                    "desc": "The item to add to the tracker.",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "TrackedCleaner"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 130,
                "path": "src/Commons/Cleaner.luau"
            }
        },
        {
            "name": "Remove",
            "desc": "Remove an item from the tracker.\n\n```lua\nlocal TrackedCleaner = require(game:GetService(\"ReplicatedStorage\"):WaitForChild(\"Commons\")).Cleaner.TrackedCleaner\nlocal MyCleaner = TrackedCleaner.new()\n\nMyCleaner:Add(workspace.MyPart)\n\nMyCleaner:Remove(workspace.MyPart)\n```",
            "params": [
                {
                    "name": "item",
                    "desc": "The item to remove from the tracker.",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "TrackedCleaner"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 150,
                "path": "src/Commons/Cleaner.luau"
            }
        },
        {
            "name": "Destroy",
            "desc": "Destroy the tracker, and cleanup everything inside it.\n\n```lua\nlocal TrackedCleaner = require(game:GetService(\"ReplicatedStorage\"):WaitForChild(\"Commons\")).Cleaner.TrackedCleaner\nlocal MyCleaner = TrackedCleaner.new()\n\nMyCleaner:Add(workspace.MyPart)\n\nMyCleaner:Destroy() -- workspace.MyPart is destroyed, as it is being tracked by the cleaner.\n```",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 172,
                "path": "src/Commons/Cleaner.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "TrackedCleaner",
    "desc": "The TrackedCleaner class allows for real time tracking and cleaning of variables.",
    "source": {
        "line": 99,
        "path": "src/Commons/Cleaner.luau"
    }
}