Skip to main content

GuiVisibleManager

This item only works when running on the client. Client

Help manage the visibility of Guis while only constructing the Gui while visible.

See BasicPaneUtils.whenVisibleBrio for a version that is written in Rx.

Functions​

new​

</>
GuiVisibleManager.new(
promiseNewPane: (maid: Maid) → Promise<TPane>,--

Returns a promise for a new pane.

maxHideTime: number?--

Optional hide time

) → GuiVisibleManager

Constructs a new GuiVisibleManager.

IsVisible​

</>
GuiVisibleManager:IsVisible() → boolean

Returns whether the Gui is visible.

BindToBoolValue​

</>
GuiVisibleManager:BindToBoolValue(boolValue: BoolValue) → ()

Binds visiblity to the bool value being true. There could be other ways that the Gui is shown if this is not set.

CreateShowHandle​

</>
GuiVisibleManager:CreateShowHandle(doNotAnimate: boolean | nil) → MaidTask

Creates a handle that will force the gui to be rendered. Clean up the task to stop the showing.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new GuiVisibleManager.",
            "params": [
                {
                    "name": "promiseNewPane",
                    "desc": "Returns a promise for a new pane.",
                    "lua_type": "(maid: Maid) -> Promise<TPane>"
                },
                {
                    "name": "maxHideTime",
                    "desc": "Optional hide time",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "GuiVisibleManager"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 29,
                "path": "src/guivisiblemanager/src/Client/GuiVisibleManager.lua"
            }
        },
        {
            "name": "IsVisible",
            "desc": "Returns whether the Gui is visible.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 57,
                "path": "src/guivisiblemanager/src/Client/GuiVisibleManager.lua"
            }
        },
        {
            "name": "BindToBoolValue",
            "desc": "Binds visiblity to the bool value being true. There could be other ways\nthat the Gui is shown if this is not set.",
            "params": [
                {
                    "name": "boolValue",
                    "desc": "",
                    "lua_type": "BoolValue"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 67,
                "path": "src/guivisiblemanager/src/Client/GuiVisibleManager.lua"
            }
        },
        {
            "name": "CreateShowHandle",
            "desc": "Creates a handle that will force the gui to be rendered. Clean up the task\nto stop the showing.",
            "params": [
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean | nil"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "MaidTask"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 93,
                "path": "src/guivisiblemanager/src/Client/GuiVisibleManager.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "GuiVisibleManager",
    "desc": "Help manage the visibility of Guis while only constructing the Gui while visible.\n\nSee [BasicPaneUtils.whenVisibleBrio] for a version that is written in Rx.",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 9,
        "path": "src/guivisiblemanager/src/Client/GuiVisibleManager.lua"
    }
}