Skip to main content

ODIncrementalTimeoutCooldown class

under construction

We are still working the API Reference! This page might be incomplete or doesn't contain all details!

Overview​

This is an Open Ticket incremental timeout cooldown.

It is is a cooldown based on an incremental timer. It is exactly the same as the normal timer, with the only difference being that it adds additional time when triggered/updated while the cooldown is already active.

View Source

Properties​

Methods​

Other​

Properties​

inherited data class ➜ api.ODManager​

(no description)

View Source

inherited id class ➜ api.ODId​

The id of this data.

View Source

incrementMs number ➜ number​

The amount of milliseconds to add when triggered/updated while the cooldown is already active.

View Source

inherited ready boolean ➜ boolean​

Is this cooldown already initialized?

View Source

timeoutMs number ➜ number​

The amount of milliseconds before the cooldown times-out

View Source

Methods​

constructor() function ➜ api.ODIncrementalTimeoutCooldown​

(no description)

View Parameters (3)
  • id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.
  • timeoutMs: number ➜ number - Parameter Description Lorem Ipsum.
  • incrementMs: number ➜ number - Parameter Description Lorem Ipsum.

View Source

inherited protected _change() function ➜ void​

Trigger an onChange() event in the parent ODManager of this class.

View Source

inherited changed() function ➜ void​

(❌ SYSTEM ONLY!!) Set the callback executed when a value inside this class changes.

View Parameters (1)
  • callback: type ➜ null|(() => void) - Parameter Description Lorem Ipsum.

View Source

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.

View Source

delete() function ➜ void​

Remove the cooldown for an id when available.

View Parameters (1)
  • id: string ➜ string - Parameter Description Lorem Ipsum.

View Source

init() function ➜ Promise​

Initialize the internal systems of this cooldown.

View Source

remaining() function ➜ null|number​

Get the remaining amount of milliseconds before the timeout stops.

View Parameters (1)
  • id: string ➜ string - Parameter Description Lorem Ipsum.

View Source

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.

View Source

Defaults​

under construction

We're still working on this part of the documentation!

Examples​

under construction

We're still working on this part of the documentation!