Skip to main content

Config

This item only works when running on the client. Client

A table of utility functions that can be used to speed up the process of writing repository scripts for client objects.

Functions​

getConfig​

</>
Config.getConfig(
scope: Scope?,
config: Instance,
defaults: T
) → ()

Returns the given config instance as a table. If any properties are missing from the instance, it will use the value from the defaults table.

Show raw api
{
    "functions": [
        {
            "name": "getConfig",
            "desc": "Returns the given `config` instance as a table. If any properties are\nmissing from the instance, it will use the value from the `defaults` table.",
            "params": [
                {
                    "name": "scope",
                    "desc": "",
                    "lua_type": "Scope?"
                },
                {
                    "name": "config",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "defaults",
                    "desc": "",
                    "lua_type": "T"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 137,
                "path": "mirror/Kit.Utility.Config.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Config",
    "desc": "A table of utility functions that can be used to speed up the process of writing repository scripts for client objects.",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 37,
        "path": "mirror/Kit.Utility.Config.luau"
    }
}