Skip to main content

MultipleClickUtils

Utility library for detecting multiple clicks or taps. Not good UX, but good for opening up a debug menus.

Functions​

observeDoubleClick​

</>
MultipleClickUtils.observeDoubleClick(gui: GuiBase) → Observable<InputObject>

Observes a double click on the Gui

getDoubleClickSignal​

</>
MultipleClickUtils.getDoubleClickSignal(
maid: Maid,
gui: GuiBase
) → Signal<InputObject>

Returns a signal that fires when the player clicks or taps on a Gui twice.

observeMultipleClicks​

</>
MultipleClickUtils.observeMultipleClicks(
gui: GuiBase,
requiredCount: number
) → Observable<InputObject>

Observes multiple clicks click on the Gui

onMultipleClicks​

</>
MultipleClickUtils.onMultipleClicks(requiredCount: number) → (gui: GuiBase) → Observable<InputObject>

For use in Blend. Observes multiple clicks.

Blend.New "TextButton" {
	[MultipleClickUtils.onMultipleClicks(3)] = function()
		print("Clicked")
	end;
};

getMultipleClickSignal​

</>
MultipleClickUtils.getMultipleClickSignal(
maid: Maid,
gui: GuiBase,
requiredCount: number
) → Signal<InputObject>

Returns a signal that fires when the player clicks or taps on a Gui a certain amount of times.

Show raw api
{
    "functions": [
        {
            "name": "observeDoubleClick",
            "desc": "Observes a double click on the Gui",
            "params": [
                {
                    "name": "gui",
                    "desc": "",
                    "lua_type": "GuiBase"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<InputObject>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 27,
                "path": "src/multipleclickutils/src/Client/MultipleClickUtils.lua"
            }
        },
        {
            "name": "getDoubleClickSignal",
            "desc": "Returns a signal that fires when the player clicks or taps on a Gui twice.",
            "params": [
                {
                    "name": "maid",
                    "desc": "",
                    "lua_type": "Maid"
                },
                {
                    "name": "gui",
                    "desc": "",
                    "lua_type": "GuiBase"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Signal<InputObject>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 38,
                "path": "src/multipleclickutils/src/Client/MultipleClickUtils.lua"
            }
        },
        {
            "name": "observeMultipleClicks",
            "desc": "Observes multiple clicks click on the Gui",
            "params": [
                {
                    "name": "gui",
                    "desc": "",
                    "lua_type": "GuiBase"
                },
                {
                    "name": "requiredCount",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<InputObject>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 49,
                "path": "src/multipleclickutils/src/Client/MultipleClickUtils.lua"
            }
        },
        {
            "name": "onMultipleClicks",
            "desc": "For use in Blend. Observes multiple clicks.\n\n```lua\nBlend.New \"TextButton\" {\n\t[MultipleClickUtils.onMultipleClicks(3)] = function()\n\t\tprint(\"Clicked\")\n\tend;\n};\n```",
            "params": [
                {
                    "name": "requiredCount",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "(gui: GuiBase) -> Observable<InputObject>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 79,
                "path": "src/multipleclickutils/src/Client/MultipleClickUtils.lua"
            }
        },
        {
            "name": "getMultipleClickSignal",
            "desc": "Returns a signal that fires when the player clicks or taps on a Gui a certain amount\nof times.",
            "params": [
                {
                    "name": "maid",
                    "desc": "",
                    "lua_type": "Maid"
                },
                {
                    "name": "gui",
                    "desc": "",
                    "lua_type": "GuiBase"
                },
                {
                    "name": "requiredCount",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Signal<InputObject>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 96,
                "path": "src/multipleclickutils/src/Client/MultipleClickUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "MultipleClickUtils",
    "desc": "Utility library for detecting multiple clicks or taps. Not good UX, but good for opening up a debug\nmenus.",
    "source": {
        "line": 7,
        "path": "src/multipleclickutils/src/Client/MultipleClickUtils.lua"
    }
}