Added CooldownProvider - Version Increment

build.gradle.kts

@@ -5,7 +5,7 @@ plugins {
 }
 
 group = "com.iridium"
-version = "1.7.4"
+version = "1.7.5"
 description = "IridiumCore"
 
 allprojects {

plugin/src/main/java/com/iridium/iridiumcore/CooldownProvider.java

@@ -0,0 +1,59 @@
+package com.iridium.iridiumcore;
+
+import java.time.Duration;
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * Provides various cooldown features.
+ *
+ * @param <T> The type that can have this cooldown
+ */
+public class CooldownProvider<T> {
+
+    private final Map<T, Duration> cooldownTimes = new HashMap<>();
+    private final Duration duration;
+
+    /**
+     * The default constructor.
+     *
+     * @param duration The duration which cooldowns from this provider have.
+     */
+    public CooldownProvider(Duration duration) {
+        this.duration = duration;
+    }
+
+    /**
+     * Returns if the specified entity has a valid cooldown.
+     *
+     * @param t The entity which should be checked
+     * @return True if the entity has a valid cooldown
+     */
+    public boolean isOnCooldown(T t) {
+        return cooldownTimes.containsKey(t) && cooldownTimes.get(t).toMillis() > System.currentTimeMillis();
+    }
+
+    /**
+     * Returns the remaining duration of the cooldown for the provided entity.
+     * ZERO if there is no cooldown.
+     *
+     * @param t The entity which should be checked
+     * @return The duration of the cooldown, can be ZERO
+     */
+    public Duration getRemainingTime(T t) {
+        if (!isOnCooldown(t)) return Duration.ZERO;
+
+        return cooldownTimes.get(t).minusMillis(System.currentTimeMillis());
+    }
+
+    /**
+     * Reset the cooldown of the specified entity with the duration of this CooldownProvider.
+     * {@link CooldownProvider#isOnCooldown(Object)} will return true after this.
+     *
+     * @param t The entity which should be checked
+     */
+    public void applyCooldown(T t) {
+        cooldownTimes.put(t, duration.plusMillis(System.currentTimeMillis()));
+    }
+
+}