Skip to main content

CooldownUtils

Helper methods for cooldown. See RxCooldownUtils for Rx utilities.

Functions​

create​

</>
CooldownUtils.create(
parent: Instance,
length: number
) → Instance

Creates a new Roblox instance representing a cooldown.

findCooldown​

</>
CooldownUtils.findCooldown(
cooldownBinder: Binder<Cooldown | CooldownClient>,
parent: Instance
) → Cooldown? | CooldownClient?

Finds a cooldown in a parent.

clone​

</>
CooldownUtils.clone(cooldown: Instance) → Instance

Makes a copy of the cooldown

Show raw api
{
    "functions": [
        {
            "name": "create",
            "desc": "Creates a new Roblox instance representing a cooldown.",
            "params": [
                {
                    "name": "parent",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "length",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 20,
                "path": "src/cooldown/src/Shared/CooldownUtils.lua"
            }
        },
        {
            "name": "findCooldown",
            "desc": "Finds a cooldown in a parent.",
            "params": [
                {
                    "name": "cooldownBinder",
                    "desc": "",
                    "lua_type": "Binder<Cooldown | CooldownClient>"
                },
                {
                    "name": "parent",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Cooldown? | CooldownClient?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 42,
                "path": "src/cooldown/src/Shared/CooldownUtils.lua"
            }
        },
        {
            "name": "clone",
            "desc": "Makes a copy of the cooldown",
            "params": [
                {
                    "name": "cooldown",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 55,
                "path": "src/cooldown/src/Shared/CooldownUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "CooldownUtils",
    "desc": "Helper methods for cooldown. See [RxCooldownUtils] for [Rx] utilities.",
    "source": {
        "line": 5,
        "path": "src/cooldown/src/Shared/CooldownUtils.lua"
    }
}