ODTimeoutCooldown 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 timeout cooldown.
It is a cooldown based on a timer. When triggered/updated, the cooldown is activated for the set amount of time. After the timer has timed out, the cooldown will be deleted.
Properties
inherited data class ➜ api.ODManager
(no description)
inherited id class ➜ api.ODId
The id of this data.
inherited ready boolean ➜ boolean
Is this cooldown already initialized?
timeoutMs number ➜ number
The amount of milliseconds before the cooldown times-out
Methods
constructor() function ➜ api.ODTimeoutCooldown
(no description)
View Parameters (2)
id: type ➜api.ODValidId- Parameter Description Lorem Ipsum.timeoutMs: number ➜number- 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.
remaining() function ➜ null|number
Get the remaining amount of milliseconds before the timeout stops.
View Parameters (1)
id: string ➜string- Parameter Description Lorem Ipsum.
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!