Package net.minestom.server.utils.time

Class Cooldown

java.lang.Object

net.minestom.server.utils.time.Cooldown

public final class Cooldown
extends Object

Constructor Summary

Constructors

Constructor	Description
Cooldown(Duration duration)

Method Summary

Modifier and Type	Method	Description
Duration	getDuration()
static boolean	hasCooldown(long currentTime, long lastUpdate, @NotNull Duration duration)	Gets if something is in cooldown based on the current time.
static boolean	hasCooldown(long currentTime, long lastUpdate, @NotNull TemporalUnit temporalUnit, long cooldown)	Gets if something is in cooldown based on the current time.
static boolean	hasCooldown(long lastUpdate, @NotNull TemporalUnit temporalUnit, int cooldown)	Gets if something is in cooldown based on the current time (System.currentTimeMillis()).
boolean	isReady(long time)
void	refreshLastUpdate(long lastUpdate)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Cooldown

public Cooldown(Duration duration)

Method Details

getDuration

public Duration getDuration()

refreshLastUpdate

public void refreshLastUpdate(long lastUpdate)

isReady

public boolean isReady(long time)

hasCooldown

public static boolean hasCooldown(long currentTime,
 long lastUpdate,
 @NotNull
 @NotNull TemporalUnit temporalUnit,
 long cooldown)

Gets if something is in cooldown based on the current time.

Parameters:

currentTime - the current time in milliseconds

lastUpdate - the last update in milliseconds

temporalUnit - the time unit of the cooldown

cooldown - the value of the cooldown

Returns:

true if the cooldown is in progress, false otherwise

hasCooldown

public static boolean hasCooldown(long currentTime,
 long lastUpdate,
 @NotNull
 @NotNull Duration duration)

Gets if something is in cooldown based on the current time.

Parameters:

currentTime - the current time in milliseconds

lastUpdate - the last update in milliseconds

duration - the cooldown

Returns:

true if the cooldown is in progress, false otherwise

hasCooldown

public static boolean hasCooldown(long lastUpdate,
 @NotNull
 @NotNull TemporalUnit temporalUnit,
 int cooldown)

Gets if something is in cooldown based on the current time (System.currentTimeMillis()).

Parameters:

lastUpdate - the last update in milliseconds

temporalUnit - the time unit of the cooldown

cooldown - the value of the cooldown

Returns:

true if the cooldown is in progress, false otherwise