cooldown/com.peco2282.devcore.cooldown/Cooldowns

Cooldowns

class Cooldowns<K : Any>(timeSource: TimeSource = SystemTimeSource)

Manages cooldowns for keys of type K.

This class provides a way to track and enforce time-based intervals between actions associated with specific keys. It is thread-safe as it uses ConcurrentHashMap internally.

Parameters

the type of the key used to identify cooldowns

Constructors

Cooldowns

constructor(timeSource: TimeSource = SystemTimeSource)

Functions

clear

fun clear(key: K)

Clears the cooldown for the specified key.

clearAll

fun clearAll()

Clears all cooldowns currently managed by this instance.

isReady

fun isReady(key: K): Boolean

Returns whether the specified key is ready to be used.

purgeExpired

fun purgeExpired()

Periodically purges expired cooldowns and executes their callbacks.

remainingMillis

fun remainingMillis(key: K): Long

Returns the remaining cooldown time in milliseconds for the specified key.

set

fun set(key: K, cooldownMillis: Long, onExpiry: () -> Unit = {})

Sets the cooldown for the specified key in milliseconds.

fun set(key: K, cooldown: Duration, onExpiry: () -> Unit = {})

Sets the cooldown for the specified key using a Duration.

tryUse

fun tryUse(key: K, cooldownMillis: Long, onExpiry: () -> Unit = {}): Boolean

Tries to use the specified key with the given cooldownMillis.

fun tryUse(key: K, cooldown: Duration, onExpiry: () -> Unit = {}): Boolean

Tries to use the specified key with the given cooldown.

tryUse

fun PlayerCooldowns.tryUse(player: Player, cooldown: Duration): Boolean

Tries to use the cooldown for the specified player with the given cooldown.