cooldown

fun cooldown(group: String, duration: Duration, scope: RateLimitScope = RateLimitScope.USER, deleteOnRefill: Boolean = true, block: ReceiverConsumer<RateLimitBuilder> = ReceiverConsumer.noop()): RateLimitInfo(source)

Creates a rate limit-based cooldown.

Cooldown cancellation

The cooldown can be cancelled inside the command with CancellableRateLimit.cancelRateLimit on your event.

Parameters

group

The name of the underlying rate limiter

scope

The scope of the cooldown

duration

The duration before the cooldown expires

block

Further configures the RateLimitBuilder

See also