Skip to main content

GuiManager

This item only works when running on the client. Client

Manager module for GUIs (mainly EffectGui), used for things such as the boost & key display.

Functions​

CreateBoostFrame​

</>
GuiManager:CreateBoostFrame(boostData: CharacterManager_Types.BoostData) → _TDefs.BoostTimerFrame

Creates and returns a boost timer frame for the given boostType. The visual data for every type is defined in the BOOST_TIMER_DATA table.

UpdateBoostFrame​

</>
GuiManager:UpdateBoostFrame(boostData: CharacterManager_Types.BoostData) → ()

Updates a boost's timer frame.

FormatBoostTimer​

</>
GuiManager:FormatBoostTimer(boostData: CharacterManager_Types.BoostData) → string

Helper function that formats a boost's remaining time into a string.

DestroyBoostFrame​

</>
GuiManager:DestroyBoostFrame(boostData: CharacterManager_Types.BoostData) → ()

Destroys the given boost's timer frame, fading it out and deleting it when finished

BindKeyCache​

</>
GuiManager:BindKeyCache(cache: _TDefs.KeyCache) → ()

Binds the given cache to the key cache.

UnbindKeyCache​

</>
GuiManager:UnbindKeyCache(cache: _TDefs.KeyCache) → ()

Unbinds the given cache from the key cache.

DisplayGUI​

</>
GuiManager:DisplayGUI(
guiName: string,
...: any
) → ()

Displays the GUI with the given guiName on the player's screen.

Show raw api
{
    "functions": [
        {
            "name": "CreateBoostFrame",
            "desc": "Creates and returns a boost timer frame for the given `boostType`.\nThe visual data for every type is defined in the `BOOST_TIMER_DATA` table.",
            "params": [
                {
                    "name": "boostData",
                    "desc": "",
                    "lua_type": "CharacterManager_Types.BoostData"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "_TDefs.BoostTimerFrame\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 89,
                "path": "mirror/Kit.Managers.GuiManager.luau"
            }
        },
        {
            "name": "UpdateBoostFrame",
            "desc": "Updates a boost's timer frame.",
            "params": [
                {
                    "name": "boostData",
                    "desc": "",
                    "lua_type": "CharacterManager_Types.BoostData"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 129,
                "path": "mirror/Kit.Managers.GuiManager.luau"
            }
        },
        {
            "name": "FormatBoostTimer",
            "desc": "Helper function that formats a boost's remaining time into a string.",
            "params": [
                {
                    "name": "boostData",
                    "desc": "",
                    "lua_type": "CharacterManager_Types.BoostData"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 151,
                "path": "mirror/Kit.Managers.GuiManager.luau"
            }
        },
        {
            "name": "DestroyBoostFrame",
            "desc": "Destroys the given boost's timer frame, fading it out and deleting it when finished",
            "params": [
                {
                    "name": "boostData",
                    "desc": "",
                    "lua_type": "CharacterManager_Types.BoostData"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 160,
                "path": "mirror/Kit.Managers.GuiManager.luau"
            }
        },
        {
            "name": "BindKeyCache",
            "desc": "Binds the given `cache` to the key cache.",
            "params": [
                {
                    "name": "cache",
                    "desc": "",
                    "lua_type": "_TDefs.KeyCache"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 178,
                "path": "mirror/Kit.Managers.GuiManager.luau"
            }
        },
        {
            "name": "UnbindKeyCache",
            "desc": "Unbinds the given `cache` from the key cache.",
            "params": [
                {
                    "name": "cache",
                    "desc": "",
                    "lua_type": "_TDefs.KeyCache"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 187,
                "path": "mirror/Kit.Managers.GuiManager.luau"
            }
        },
        {
            "name": "DisplayGUI",
            "desc": "Displays the GUI with the given `guiName` on the player's screen.",
            "params": [
                {
                    "name": "guiName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 273,
                "path": "mirror/Kit.Managers.GuiManager.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "GuiManager",
    "desc": "Manager module for GUIs (mainly EffectGui), used for things such as the boost & key display.",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 13,
        "path": "mirror/Kit.Managers.GuiManager.luau"
    }
}