Skip to main content

GuiInteractionUtils

Functions

observeInteractionEnabled

GuiInteractionUtils.observeInteractionEnabled(guiGuiObject) → Observable<boolean>

Observes whether a Gui is interactable

observeInteractionEnabledBrio

GuiInteractionUtils.observeInteractionEnabledBrio(guiGuiObject) → Observable<Brio>

Observes whether a Gui is interactable, and returns a Brio only during interaction.

Show raw api
{
    "functions": [
        {
            "name": "observeInteractionEnabled",
            "desc": "Observes whether a Gui is interactable",
            "params": [
                {
                    "name": "gui",
                    "desc": "",
                    "lua_type": "GuiObject"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 19,
                "path": "src/uiobjectutils/src/Client/GuiInteractionUtils.lua"
            }
        },
        {
            "name": "observeInteractionEnabledBrio",
            "desc": "Observes whether a Gui is interactable, and returns a Brio only during\ninteraction.",
            "params": [
                {
                    "name": "gui",
                    "desc": "",
                    "lua_type": "GuiObject"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 44,
                "path": "src/uiobjectutils/src/Client/GuiInteractionUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "GuiInteractionUtils",
    "desc": "",
    "source": {
        "line": 4,
        "path": "src/uiobjectutils/src/Client/GuiInteractionUtils.lua"
    }
}