Skip to main content

Cooldown

This item only works when running on the server. Server

Represents a cooldown state with a time limit. See CooldownBase for more API.

Functions​

new​

</>
Cooldown.new(
numberValue: NumberValue,
serviceBag: ServiceBag
) → Cooldown

Constructs a new cooldown. Should be done via Binder.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new cooldown. Should be done via [Binder].",
            "params": [
                {
                    "name": "numberValue",
                    "desc": "",
                    "lua_type": "NumberValue"
                },
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Cooldown"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 28,
                "path": "src/cooldown/src/Server/Binders/Cooldown.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Cooldown",
    "desc": "Represents a cooldown state with a time limit. See [CooldownBase] for more API.",
    "realm": [
        "Server"
    ],
    "source": {
        "line": 7,
        "path": "src/cooldown/src/Server/Binders/Cooldown.lua"
    }
}