Skip to main content

ClientObjectManager

This item only works when running on the client. Client

Manager module responsible for loading client objects.

Functions​

ScanFolder​

</>
ClientObjectManager:ScanFolder(
targetScope: ScopeTypes.Scope,
path: Instance,
targetPath: Instance?
) → ()

Scans the given folder for Client Objects and loads their scripts. Used when certain Client Objects (such as Pushboxes) spawn other COs.

LoadClientObjects​

</>
ClientObjectManager:LoadClientObjects(
from: Instance,
target: Instance,
tower: string,
towerRepository: Instance?
) → ()

Loads the client objects found in from into the target, setting them up and running their respective repository scripts.

towerRepository determines where the repository scripts for COs will be retrieved from. If not set, this will default to Framework.Kit.Repository.

Show raw api
{
    "functions": [
        {
            "name": "ScanFolder",
            "desc": "Scans the given folder for Client Objects and loads their scripts.\nUsed when certain Client Objects (such as Pushboxes) spawn other COs.",
            "params": [
                {
                    "name": "targetScope",
                    "desc": "",
                    "lua_type": "ScopeTypes.Scope"
                },
                {
                    "name": "path",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "targetPath",
                    "desc": "",
                    "lua_type": "Instance?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 140,
                "path": "mirror/Kit.Managers.ClientObjectManager.luau"
            }
        },
        {
            "name": "LoadClientObjects",
            "desc": "Loads the client objects found in `from` into the `target`, setting them up and running\ntheir respective repository scripts.\n\n`towerRepository` determines where the repository scripts for COs will be retrieved from.\nIf not set, this will default to `Framework.Kit.Repository`.",
            "params": [
                {
                    "name": "from",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "target",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "tower",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "towerRepository",
                    "desc": "",
                    "lua_type": "Instance?\n"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 209,
                "path": "mirror/Kit.Managers.ClientObjectManager.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "ClientObjectManager",
    "desc": "Manager module responsible for loading client objects.",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 13,
        "path": "mirror/Kit.Managers.ClientObjectManager.luau"
    }
}