Skip to main content

SweeperUtils

Functions​

IsValid​

</>
SweeperUtils.IsValid(
obj: any,
destroyMethod: string?
) → ()

Check if the passed obj is something which can be handled by a Sweeper.

Show raw api
{
    "functions": [
        {
            "name": "IsValid",
            "desc": "Check if the passed `obj` is something which can be handled by a Sweeper.",
            "params": [
                {
                    "name": "obj",
                    "desc": "",
                    "lua_type": "any"
                },
                {
                    "name": "destroyMethod",
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 9,
                "path": "packages/sweeper/source/SweeperUtils.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SweeperUtils",
    "desc": "",
    "source": {
        "line": 4,
        "path": "packages/sweeper/source/SweeperUtils.luau"
    }
}