Skip to main content

coreGuiUtil

A simple utility module for working with CoreGui's API.

Functions​

setCorePromise​

</>
coreGuiUtil.setCorePromise(
coreGuiName: string,
...: any
) → Promise<>

Returns a promise which is resolved once StarterGui:SetCore has successfully executed.

coreGuiUtil.setCorePromise("AvatarContextMenuTheme", {
    BackgroundImage = "", 
    BackgroundTransparency = 0.5, 
    BackgroundColor = Color3.fromRGB(111, 145, 242),
    NameTagColor = Color3.fromRGB(0, 0, 200),
    NameUnderlineColor = Color3.fromRGB(213, 233, 255),
    ButtonFrameColor = Color3.fromRGB(15, 24, 65), 
    ButtonFrameTransparency = 0.2, 
    ButtonUnderlineColor = Color3.fromRGB(213, 233, 255), 
    Font = Enum.Font.SciFi
}):andThen(function()
    print("Successfully set core AvatarContextMenuTheme")
end)
Show raw api
{
    "functions": [
        {
            "name": "setCorePromise",
            "desc": "Returns a [promise](https://eryn.io/roblox-lua-promise/) which is resolved once [StarterGui:SetCore](https://create.roblox.com/docs/reference/engine/classes/StarterGui#SetCore) has successfully executed.\n\n```lua\ncoreGuiUtil.setCorePromise(\"AvatarContextMenuTheme\", {\n    BackgroundImage = \"\", \n    BackgroundTransparency = 0.5, \n    BackgroundColor = Color3.fromRGB(111, 145, 242),\n    NameTagColor = Color3.fromRGB(0, 0, 200),\n    NameUnderlineColor = Color3.fromRGB(213, 233, 255),\n    ButtonFrameColor = Color3.fromRGB(15, 24, 65), \n    ButtonFrameTransparency = 0.2, \n    ButtonUnderlineColor = Color3.fromRGB(213, 233, 255), \n    Font = Enum.Font.SciFi\n}):andThen(function()\n    print(\"Successfully set core AvatarContextMenuTheme\")\nend)\n```",
            "params": [
                {
                    "name": "coreGuiName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 34,
                "path": "src/coreGuiUtil/init.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "coreGuiUtil",
    "desc": " \n\nA simple utility module for working with [CoreGui](https://create.roblox.com/docs/reference/engine/classes/CoreGui)'s API.",
    "source": {
        "line": 6,
        "path": "src/coreGuiUtil/init.luau"
    }
}