Skip to main content

CooldownClient

This item only works when running on the client. Client

Handles cooldown on the client. See CooldownBase for details.

Functions

new

CooldownClient.new(
numberValueNumberValue,
serviceBagServiceBag
) → Cooldown

Constructs a new cooldown. Should be done via [CooldownBindersClient]. To create an instance of this in Roblox, see CooldownUtils.create.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new cooldown. Should be done via [CooldownBindersClient]. To create an\ninstance of this in Roblox, see [CooldownUtils.create].",
            "params": [
                {
                    "name": "numberValue",
                    "desc": "",
                    "lua_type": "NumberValue"
                },
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Cooldown"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 25,
                "path": "src/cooldown/src/Client/Binders/CooldownClient.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "CooldownClient",
    "desc": "Handles cooldown on the client. See [CooldownBase] for details.",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 7,
        "path": "src/cooldown/src/Client/Binders/CooldownClient.lua"
    }
}