Skip to main content

Runner

Quick and dirty service-runner module for initializing modules.

Types​

ActiveRunner​

</>
type ActiveRunner = string | Instance | {Instance}

A base type for all ActiveRunners, contains the loaded modules, module container and version.

RunnerParams​

</>
type RunnerParams = boolean | Instance

A type for the parameters of the Runner constructor.

Functions​

new​

</>
Runner.new(
Modules: Instance,--

The module container to load modules from

Params: {
DynamicLoad: boolean,
DynamicContainer: Instance
}--

Parameters for dynamic loading

) → ActiveRunner--

Returns a new ActiveRunner instance

Creates a new ActiveRunner instance.

Show raw api
{
    "functions": [
        {
            "name": "debugPrint",
            "desc": "Cooler print.",
            "params": [
                {
                    "name": "str",
                    "desc": "I aint documenting this",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "static",
            "private": true,
            "yields": true,
            "source": {
                "line": 44,
                "path": "src/shared/Runner/init.luau"
            }
        },
        {
            "name": "debugWarn",
            "desc": "Cooler warn.",
            "params": [
                {
                    "name": "str",
                    "desc": "I aint documenting this",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "static",
            "private": true,
            "yields": true,
            "source": {
                "line": 56,
                "path": "src/shared/Runner/init.luau"
            }
        },
        {
            "name": "new",
            "desc": "Creates a new ActiveRunner instance.",
            "params": [
                {
                    "name": "Modules",
                    "desc": "The module container to load modules from",
                    "lua_type": "Instance"
                },
                {
                    "name": "Params",
                    "desc": "Parameters for dynamic loading",
                    "lua_type": "{DynamicLoad: boolean, DynamicContainer: Instance}"
                }
            ],
            "returns": [
                {
                    "desc": "Returns a new ActiveRunner instance",
                    "lua_type": "ActiveRunner"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 68,
                "path": "src/shared/Runner/init.luau"
            }
        }
    ],
    "properties": [],
    "types": [
        {
            "name": "ActiveRunner",
            "desc": "A base type for all ActiveRunners, contains the loaded modules, module container and version.",
            "lua_type": "string | Instance | {Instance}",
            "source": {
                "line": 14,
                "path": "src/shared/Runner/init.luau"
            }
        },
        {
            "name": "RunnerParams",
            "desc": "A type for the parameters of the Runner constructor.",
            "lua_type": "boolean | Instance",
            "source": {
                "line": 25,
                "path": "src/shared/Runner/init.luau"
            }
        }
    ],
    "name": "Runner",
    "desc": "Quick and dirty service-runner module for initializing modules.",
    "source": {
        "line": 8,
        "path": "src/shared/Runner/init.luau"
    }
}