Skip to main content

Initializer

Safely initializes modules, either ordered or unordered.

Functions

InitModuleAsync

Initializer.InitModuleAsync(
ObjectInstance--

The module being initialized

) → ()

Initializes a module, preventing re-initalization and thrown errors.

local Module = path.to.module -- Don't require it!

Initializer.InitModuleAsync(Module)

InitFolderAsync

Initializer.InitFolderAsync(
FolderInstance--

The bin of modules being initialized

) → ()

Initializes children modules in a bin, unordered.

local Folder = path.to.folder

Initializer.InitFolderAsync(Folder)

InitOrderedFolderAsync

Initializer.InitOrderedFolderAsync(
FolderInstance,--

The bin of modules being initialized

Order{string}--

The load order

) → ()

Initializes children modules in a bin, ordered based on an inputted array of module names.

local Folder = path.to.folder
local Order = {"FirstModule", "SecondModule", "ThirdModule"}

Initializer.InitOrderedFolderAsync(Folder, Order)
Show raw api
{
    "functions": [
        {
            "name": "InitModuleAsync",
            "desc": "Initializes a module, preventing re-initalization and thrown errors.\n\n```lua\nlocal Module = path.to.module -- Don't require it!\n\nInitializer.InitModuleAsync(Module)\n```",
            "params": [
                {
                    "name": "Object",
                    "desc": "The module being initialized",
                    "lua_type": "Instance"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 62,
                "path": "src/Packages/_Index/miagobble_initializer@1.0.0/initializer/init.luau"
            }
        },
        {
            "name": "InitFolderAsync",
            "desc": "Initializes children modules in a bin, unordered.\n\n```lua\nlocal Folder = path.to.folder\n\nInitializer.InitFolderAsync(Folder)\n```",
            "params": [
                {
                    "name": "Folder",
                    "desc": "The bin of modules being initialized",
                    "lua_type": "Instance"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 118,
                "path": "src/Packages/_Index/miagobble_initializer@1.0.0/initializer/init.luau"
            }
        },
        {
            "name": "InitOrderedFolderAsync",
            "desc": "Initializes children modules in a bin, ordered based on an inputted array of module names.\n\n```lua\nlocal Folder = path.to.folder\nlocal Order = {\"FirstModule\", \"SecondModule\", \"ThirdModule\"}\n\nInitializer.InitOrderedFolderAsync(Folder, Order)\n```",
            "params": [
                {
                    "name": "Folder",
                    "desc": "The bin of modules being initialized",
                    "lua_type": "Instance"
                },
                {
                    "name": "Order",
                    "desc": "The load order",
                    "lua_type": "{string}"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 138,
                "path": "src/Packages/_Index/miagobble_initializer@1.0.0/initializer/init.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Initializer",
    "desc": "Safely initializes modules, either ordered or unordered.",
    "source": {
        "line": 6,
        "path": "src/Packages/_Index/miagobble_initializer@1.0.0/initializer/init.luau"
    }
}