Skip to main content

Cleanup

This is a MapLib Feature. It can be accessed by MapLib:GetFeature("Cleanup").

Functions​

Janitor.new​

since 0.11
</>
Cleanup.Janitor.new(name: string?) → Janitor

GetJanitor​

since 0.11
</>
Cleanup:GetJanitor(janitorName: string | number) → Janitor

This method returns a Janitor class with the given name

GetJanitors​

since 0.11
</>
Cleanup:GetJanitors() → {Janitor}

This method returns all the active Janitor classes.

Show raw api
{
    "functions": [
        {
            "name": "Janitor.new",
            "desc": "",
            "params": [
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Janitor"
                }
            ],
            "function_type": "static",
            "since": "0.11",
            "source": {
                "line": 26,
                "path": "src/Features/Cleanup/init.lua"
            }
        },
        {
            "name": "GetJanitor",
            "desc": "This method returns a Janitor class with the given name",
            "params": [
                {
                    "name": "janitorName",
                    "desc": "",
                    "lua_type": "string | number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Janitor"
                }
            ],
            "function_type": "method",
            "since": "0.11",
            "source": {
                "line": 38,
                "path": "src/Features/Cleanup/init.lua"
            }
        },
        {
            "name": "GetJanitors",
            "desc": "This method returns all the active Janitor classes.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{Janitor}"
                }
            ],
            "function_type": "method",
            "since": "0.11",
            "source": {
                "line": 51,
                "path": "src/Features/Cleanup/init.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Cleanup",
    "desc": "This is a MapLib Feature. It can be accessed by `MapLib:GetFeature(\"Cleanup\")`.",
    "source": {
        "line": 18,
        "path": "src/Features/Cleanup/init.lua"
    }
}