v0.3.1 - Automatically rewrite tick values to be > 0.

A warning will automatically be triggered once unless the plugin author manually disables this behavior.

Author: TechnicallyCoded

build.gradle

@@ -7,7 +7,7 @@ buildscript {
 allprojects {
     apply plugin: 'java'
 
-    version = '0.3.0'
+    version = '0.3.1'
 
     repositories {
 

common/src/main/java/com/tcoded/folialib/FoliaLib.java

@@ -2,6 +2,7 @@
 
 import com.tcoded.folialib.enums.ImplementationType;
 import com.tcoded.folialib.impl.ServerImplementation;
+import com.tcoded.folialib.util.InvalidTickDelayNotifier;
 import org.bukkit.plugin.java.JavaPlugin;
 
 import java.lang.reflect.InvocationTargetException;
@@ -41,7 +42,8 @@ public FoliaLib(JavaPlugin plugin) {
         }
 
         // Check for valid relocation
-        // Runtime replace to avoid relocations changing this string too
+        // Runtime replace commas to avoid compiler relocations changing this string too
+        // Not beautiful, but functional
         String originalLocation = "com,tcoded,folialib,".replace(",", ".");
         if (this.getClass().getName().startsWith(originalLocation)) {
             Logger logger = this.plugin.getLogger();
@@ -53,20 +55,7 @@ public FoliaLib(JavaPlugin plugin) {
         }
     }
 
-    private ServerImplementation createServerImpl(String implName) {
-        String basePackage = this.getClass().getPackage().getName() + ".impl.";
-
-        try {
-            return (ServerImplementation) Class.forName(basePackage + implName)
-                    .getConstructor(this.getClass())
-                    .newInstance(this);
-        } catch (InstantiationException | ClassNotFoundException | NoSuchMethodException | InvocationTargetException |
-                 IllegalAccessException e) {
-            e.printStackTrace();
-        }
-
-        return null;
-    }
+    // Getters
 
     @SuppressWarnings("unused")
     public ImplementationType getImplType() {
@@ -85,12 +74,12 @@ public boolean isFolia() {
 
     @SuppressWarnings("unused")
     public boolean isPaper() {
-        return implementationType == ImplementationType.PAPER;
+        return implementationType == ImplementationType.PAPER || implementationType == ImplementationType.LEGACY_PAPER;
     }
 
     @SuppressWarnings("unused")
     public boolean isSpigot() {
-        return implementationType == ImplementationType.SPIGOT;
+        return implementationType == ImplementationType.SPIGOT || implementationType == ImplementationType.LEGACY_SPIGOT;
     }
 
     @SuppressWarnings("unused")
@@ -101,4 +90,33 @@ public boolean isUnsupported() {
     public JavaPlugin getPlugin() {
         return plugin;
     }
+
+    // Public Options
+
+    @SuppressWarnings("unused")
+    public void disableInvalidTickValueWarning() {
+        InvalidTickDelayNotifier.disableNotifications = true;
+    }
+
+    @SuppressWarnings("unused")
+    public void enableInvalidTickValueDebug() {
+        InvalidTickDelayNotifier.debugMode = true;
+    }
+
+    // Internal Utils
+
+    private ServerImplementation createServerImpl(String implName) {
+        String basePackage = this.getClass().getPackage().getName() + ".impl.";
+
+        try {
+            return (ServerImplementation) Class.forName(basePackage + implName)
+                    .getConstructor(this.getClass())
+                    .newInstance(this);
+        } catch (InstantiationException | ClassNotFoundException | NoSuchMethodException | InvocationTargetException |
+                 IllegalAccessException e) {
+            e.printStackTrace();
+        }
+
+        return null;
+    }
 }

common/src/main/java/com/tcoded/folialib/util/InvalidTickDelayNotifier.java

@@ -0,0 +1,34 @@
+package com.tcoded.folialib.util;
+
+import org.jetbrains.annotations.NotNull;
+
+import java.util.logging.Logger;
+
+public class InvalidTickDelayNotifier {
+
+    public static boolean disableNotifications = false;
+    public static boolean debugMode = false;
+
+    private static boolean notified = false;
+
+    public static void notifyOnce(@NotNull Logger logger, long span) {
+        // Check if the notification was already sent or if the notifications were manually disabled
+        if (notified || disableNotifications) return;
+        notified = true;
+
+        // Send a warning message if this hasn't been sent before
+        logger.warning(
+                String.format("A tick based delay or timer was scheduled with a time span of %d ticks. ", span) +
+                "The server is already processing the current tick and, as such, won't process new tasks in less than 1 tick. " +
+                "FoliaLib will automatically change time spans of <= 0 ticks to 1 tick going forward. " +
+                "This warning is purely informative and won't impact the operation of the plugin. " +
+                "Plugin developers can disable this warning or enable debug mode to location the source of this warning.");
+
+        // If the user enables debug mode, print the stack trace
+        if (debugMode) {
+            new Exception("Debugging information to track down the location of the invalid tick input value")
+                    .printStackTrace();
+        }
+    }
+
+}