Skip to main content

ODIncrementalCounterCooldown 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 counter cooldown.

It is is a cooldown based on an incremental counter. It is exactly the same as the normal counter, with the only difference being that it still increments when the limit is already exeeded.

View Source

Properties​

Methods​

Other​

Properties​

activeLimit number ➜ number​

The cooldown will activate when exceeding this limit.

View Source

cancelLimit number ➜ number​

The cooldown will deactivate when below this limit.

View Source

inherited data class ➜ api.ODManager​

(no description)

View Source

decrement number ➜ number​

The amount to decrease the counter over time.

View Source

inherited id class ➜ api.ODId​

The id of this data.

View Source

increment number ➜ number​

The amount to increase the counter with everytime the cooldown is triggered/updated.

View Source

invervalMs number ➜ number​

The interval between decrements in milliseconds.

View Source

inherited ready boolean ➜ boolean​

Is this cooldown already initialized?

View Source

Methods​

constructor() function ➜ api.ODIncrementalCounterCooldown​

(no description)

View Parameters (6)
  • id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.
  • activeLimit: number ➜ number - Parameter Description Lorem Ipsum.
  • cancelLimit: number ➜ number - Parameter Description Lorem Ipsum.
  • increment: number ➜ number - Parameter Description Lorem Ipsum.
  • decrement: number ➜ number - Parameter Description Lorem Ipsum.
  • intervalMs: 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

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!