Skip to main content

BaseObject

A BaseObject basically just adds the :Destroy() interface, and a _maid, along with an optional object it references.

Functions​

new​

</>
BaseObject.new(obj?: Instance) → BaseObject

Constructs a new BaseObject

Destroy​

</>
BaseObject:Destroy() → ()

Cleans up the BaseObject and sets the metatable to nil

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new BaseObject",
            "params": [
                {
                    "name": "obj?",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BaseObject"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 20,
                "path": "src/baseobject/src/Shared/BaseObject.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Cleans up the BaseObject and sets the metatable to nil",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 30,
                "path": "src/baseobject/src/Shared/BaseObject.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "BaseObject",
    "desc": "A BaseObject basically just adds the :Destroy() interface, and a _maid, along with an optional object it references.",
    "source": {
        "line": 5,
        "path": "src/baseobject/src/Shared/BaseObject.lua"
    }
}