Skip to main content

Gui

This item only works when running on the client. Client

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

Functions​

getEffectGui​

</>
Gui.getEffectGui() → typeof(GuiManager.Gui)

Returns the EffectGui.

bindKeyCache​

</>
Gui.bindKeyCache(cache: GuiManager_Types.KeyCache) → ()

See GuiManager for more info.

unbindKeyCache​

</>
Gui.unbindKeyCache(cache: GuiManager_Types.KeyCache) → ()

See GuiManager for more info.

createBoostFrame​

</>
Gui.createBoostFrame(boostData: CharacterManager_Types.BoostData) → GuiManager_Types.BoostTimerFrame

See GuiManager for more info.

updateBoostFrame​

</>
Gui.updateBoostFrame(boostData: CharacterManager_Types.BoostData) → ()

See GuiManager for more info.

formatBoostTimer​

</>
Gui.formatBoostTimer(boostData: CharacterManager_Types.BoostData) → string

See GuiManager for more info.

destroyBoostFrame​

</>
Gui.destroyBoostFrame(boostData: CharacterManager_Types.BoostData) → ()

See GuiManager for more info.

Show raw api
{
    "functions": [
        {
            "name": "getEffectGui",
            "desc": "Returns the EffectGui.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "typeof(GuiManager.Gui)\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 27,
                "path": "mirror/Kit.Utility.Gui.luau"
            }
        },
        {
            "name": "bindKeyCache",
            "desc": "See [GuiManager](/api/GuiManager#BindKeyCache) for more info.",
            "params": [
                {
                    "name": "cache",
                    "desc": "",
                    "lua_type": "GuiManager_Types.KeyCache"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 38,
                "path": "mirror/Kit.Utility.Gui.luau"
            }
        },
        {
            "name": "unbindKeyCache",
            "desc": "See [GuiManager](/api/GuiManager#UnbindKeyCache) for more info.",
            "params": [
                {
                    "name": "cache",
                    "desc": "",
                    "lua_type": "GuiManager_Types.KeyCache"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 47,
                "path": "mirror/Kit.Utility.Gui.luau"
            }
        },
        {
            "name": "createBoostFrame",
            "desc": "See [GuiManager](/api/GuiManager#CreateBoostFrame) for more info.",
            "params": [
                {
                    "name": "boostData",
                    "desc": "",
                    "lua_type": "CharacterManager_Types.BoostData"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "GuiManager_Types.BoostTimerFrame\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 56,
                "path": "mirror/Kit.Utility.Gui.luau"
            }
        },
        {
            "name": "updateBoostFrame",
            "desc": "See [GuiManager](/api/GuiManager#UpdateBoostFrame) for more info.",
            "params": [
                {
                    "name": "boostData",
                    "desc": "",
                    "lua_type": "CharacterManager_Types.BoostData"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 65,
                "path": "mirror/Kit.Utility.Gui.luau"
            }
        },
        {
            "name": "formatBoostTimer",
            "desc": "See [GuiManager](/api/GuiManager#FormatBoostTimer) for more info.",
            "params": [
                {
                    "name": "boostData",
                    "desc": "",
                    "lua_type": "CharacterManager_Types.BoostData"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 74,
                "path": "mirror/Kit.Utility.Gui.luau"
            }
        },
        {
            "name": "destroyBoostFrame",
            "desc": "See [GuiManager](/api/GuiManager#DestroyBoostFrame) for more info.",
            "params": [
                {
                    "name": "boostData",
                    "desc": "",
                    "lua_type": "CharacterManager_Types.BoostData"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 83,
                "path": "mirror/Kit.Utility.Gui.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Gui",
    "desc": "A table of utility functions for working with GUIs that can be used to speed up the process of writing repository scripts for client objects.",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 10,
        "path": "mirror/Kit.Utility.Gui.luau"
    }
}