ODCooldown class
We are still working the API Reference! This page might be incomplete or doesn't contain all details!
Overview
This is an Open Ticket cooldown.
It doesn't do anything on it's own, but it provides the methods that are used to interact with a cooldown. This class can be extended from to create a working cooldown.
There are also premade cooldowns available in the bot!
Properties
data class ➜ api.ODManager
(no description)
inherited id class ➜ api.ODId
The id of this data.
ready boolean ➜ boolean
Is this cooldown already initialized?
Methods
constructor() function ➜ api.ODCooldown
(no description)
View Parameters (1)
id: type ➜api.ODValidId- Parameter Description Lorem Ipsum.
inherited protected _change() function ➜ void
Trigger an onChange() event in the parent ODManager of this class.
inherited changed() function ➜ void
(❌ SYSTEM ONLY!!) Set the callback executed when a value inside this class changes.
check() function ➜ boolean
Check this id without starting or updating the cooldown. Returns true when on cooldown!
View Parameters (1)
id: string ➜string- Parameter Description Lorem Ipsum.
delete() function ➜ void
Remove the cooldown for an id when available.
View Parameters (1)
id: string ➜string- Parameter Description Lorem Ipsum.
init() function ➜ Promise
Initialize the internal systems of this cooldown.
use() function ➜ boolean
Check this id and start cooldown when it exeeds the limit! Returns true when on cooldown!
View Parameters (1)
id: string ➜string- Parameter Description Lorem Ipsum.
Defaults
We're still working on this part of the documentation!
Examples
We're still working on this part of the documentation!