Skip to main content

cancellableDelay

A version of task.delay that can be cancelled. Soon to be useless.

Functions​

cancellableDelay​

</>
cancellableDelay.cancellableDelay(
timeoutInSeconds: number,
func: function,
...: any--

Args to pass into the function

) → function?--

Can be used to cancel

Show raw api
{
    "functions": [
        {
            "name": "cancellableDelay",
            "desc": "",
            "params": [
                {
                    "name": "timeoutInSeconds",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "func",
                    "desc": "",
                    "lua_type": "function"
                },
                {
                    "name": "...",
                    "desc": "Args to pass into the function",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "Can be used to cancel",
                    "lua_type": "function?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 14,
                "path": "src/cancellabledelay/src/Shared/cancellableDelay.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "cancellableDelay",
    "desc": "A version of task.delay that can be cancelled. Soon to be useless.",
    "source": {
        "line": 5,
        "path": "src/cancellabledelay/src/Shared/cancellableDelay.lua"
    }
}