feat: use folialib

Author: devnatan

examples/paper/src/main/java/me/devnatan/inventoryframework/runtime/SamplePlugin.java

@@ -4,11 +4,11 @@
 import me.devnatan.inventoryframework.ViewFrame;
 import me.devnatan.inventoryframework.runtime.commands.IFExampleCommandExecutor;
 import me.devnatan.inventoryframework.runtime.listener.PigListener;
+import me.devnatan.inventoryframework.runtime.view.*;
 import me.devnatan.inventoryframework.runtime.view.AnvilInputSample;
 import me.devnatan.inventoryframework.runtime.view.AutoUpdate;
 import me.devnatan.inventoryframework.runtime.view.Failing;
 import me.devnatan.inventoryframework.runtime.view.SimplePagination;
-import me.devnatan.inventoryframework.runtime.view.*;
 import org.bukkit.plugin.java.JavaPlugin;
 
 public class SamplePlugin extends JavaPlugin {

inventory-framework-api/src/main/java/me/devnatan/inventoryframework/context/IFSlotClickContext.java

@@ -13,99 +13,99 @@
  */
 public interface IFSlotClickContext extends IFSlotContext, IFConfinedContext {
 
-	// TODO needs documentation
-	@NotNull
-	ViewContainer getClickedContainer();
-
-	Component getComponent();
-
-	int getClickedSlot();
-
-	/**
-	 * If the click was using the left mouse button.
-	 *
-	 * @return If the click was using the left mouse button.
-	 */
-	boolean isLeftClick();
-
-	/**
-	 * If the click was using the right mouse button.
-	 *
-	 * @return If the click was using the right mouse button.
-	 */
-	boolean isRightClick();
-
-	/**
-	 * If the click was using the middle mouse button, commonly known as the scroll button.
-	 *
-	 * @return If the click was using the middle mouse button.
-	 */
-	boolean isMiddleClick();
-
-	/**
-	 * If the click was accompanied by a click holding the keyboard shift button.
-	 *
-	 * @return If it was a click holding the keyboard shift button.
-	 */
-	boolean isShiftClick();
-
-	default boolean isShiftLeftClick() {
-		return isLeftClick() && isShiftClick();
-	}
-
-	default boolean isShiftRightClick() {
-		return isRightClick() && isShiftClick();
-	}
-
-	/**
-	 * If the click source came from a keyboard, e.g. the player's toolbar number.
-	 *
-	 * @return If the click source came from a keyboard.
-	 */
-	boolean isKeyboardClick();
-
-	/**
-	 * If the click did not occur within any containers.
-	 *
-	 * @return If the click did not occur within any containers.
-	 */
-	boolean isOutsideClick();
-
-	/**
-	 * The click identifier, available only in cases where the library does not cover all types of
-	 * clicks, so you can discover the type of click through its identifier.
-	 *
-	 * @return The click type identifier. Can be null if the click type is known or a platform doesn't implement an identifier.
-	 */
-	default String getClickIdentifier() {
-		return null;
-	}
-
-	/**
-	 * If the click was cancelled.
-	 *
-	 * @return If the click was cancelled.
-	 */
-	boolean isCancelled();
-
-	/**
-	 * Cancels the click.
-	 *
-	 * @param cancelled If the click should be cancelled.
-	 */
-	void setCancelled(boolean cancelled);
-
-	/**
-	 * <b><i> This is an internal inventory-framework API that should not be used from outside of
-	 * this library. No compatibility guarantees are provided. </i></b>
-	 */
-	@ApiStatus.Internal
-	Object getPlatformEvent();
-
-	/**
-	 * <b><i> This is an internal inventory-framework API that should not be used from outside of
-	 * this library. No compatibility guarantees are provided. </i></b>
-	 */
-	@ApiStatus.Internal
-	boolean isCombined();
+    // TODO needs documentation
+    @NotNull
+    ViewContainer getClickedContainer();
+
+    Component getComponent();
+
+    int getClickedSlot();
+
+    /**
+     * If the click was using the left mouse button.
+     *
+     * @return If the click was using the left mouse button.
+     */
+    boolean isLeftClick();
+
+    /**
+     * If the click was using the right mouse button.
+     *
+     * @return If the click was using the right mouse button.
+     */
+    boolean isRightClick();
+
+    /**
+     * If the click was using the middle mouse button, commonly known as the scroll button.
+     *
+     * @return If the click was using the middle mouse button.
+     */
+    boolean isMiddleClick();
+
+    /**
+     * If the click was accompanied by a click holding the keyboard shift button.
+     *
+     * @return If it was a click holding the keyboard shift button.
+     */
+    boolean isShiftClick();
+
+    default boolean isShiftLeftClick() {
+        return isLeftClick() && isShiftClick();
+    }
+
+    default boolean isShiftRightClick() {
+        return isRightClick() && isShiftClick();
+    }
+
+    /**
+     * If the click source came from a keyboard, e.g. the player's toolbar number.
+     *
+     * @return If the click source came from a keyboard.
+     */
+    boolean isKeyboardClick();
+
+    /**
+     * If the click did not occur within any containers.
+     *
+     * @return If the click did not occur within any containers.
+     */
+    boolean isOutsideClick();
+
+    /**
+     * The click identifier, available only in cases where the library does not cover all types of
+     * clicks, so you can discover the type of click through its identifier.
+     *
+     * @return The click type identifier. Can be null if the click type is known or a platform doesn't implement an identifier.
+     */
+    default String getClickIdentifier() {
+        return null;
+    }
+
+    /**
+     * If the click was cancelled.
+     *
+     * @return If the click was cancelled.
+     */
+    boolean isCancelled();
+
+    /**
+     * Cancels the click.
+     *
+     * @param cancelled If the click should be cancelled.
+     */
+    void setCancelled(boolean cancelled);
+
+    /**
+     * <b><i> This is an internal inventory-framework API that should not be used from outside of
+     * this library. No compatibility guarantees are provided. </i></b>
+     */
+    @ApiStatus.Internal
+    Object getPlatformEvent();
+
+    /**
+     * <b><i> This is an internal inventory-framework API that should not be used from outside of
+     * this library. No compatibility guarantees are provided. </i></b>
+     */
+    @ApiStatus.Internal
+    boolean isCombined();
 }

inventory-framework-platform-bukkit/build.gradle.kts

@@ -17,6 +17,7 @@ dependencies {
     testRuntimeOnly(libs.spigot)
     testImplementation(projects.inventoryFrameworkApi)
     testImplementation(projects.inventoryFrameworkTest)
+    implementation(libs.folialib)
 }
 
 tasks.shadowJar {

inventory-framework-platform-bukkit/src/main/java/me/devnatan/inventoryframework/ViewFrame.java

@@ -38,10 +38,6 @@ public class ViewFrame extends IFViewFrame<ViewFrame, View> {
     private final Plugin owner;
     private final FeatureInstaller<ViewFrame> featureInstaller = new DefaultFeatureInstaller<>(this);
 
-    static {
-        PlatformUtils.setFactory(new BukkitElementFactory());
-    }
-
     private ViewFrame(Plugin owner) {
         this.owner = owner;
     }
@@ -191,6 +187,7 @@ public final void openEndless(
     public final ViewFrame register() {
         if (isRegistered()) throw new IllegalStateException("This view frame is already registered");
 
+        PlatformUtils.setFactory(new BukkitElementFactory(getOwner()));
         tryEnableMetrics();
         checkRelocationIssues();
         setRegistered(true);

inventory-framework-platform-bukkit/src/main/java/me/devnatan/inventoryframework/internal/BukkitElementFactory.java

@@ -2,6 +2,7 @@
 
 import static me.devnatan.inventoryframework.runtime.util.InventoryUtils.checkInventoryTypeSupport;
 
+import com.tcoded.folialib.FoliaLib;
 import java.util.List;
 import java.util.Map;
 import java.util.UUID;
@@ -14,10 +15,12 @@
 import me.devnatan.inventoryframework.context.*;
 import me.devnatan.inventoryframework.logging.Logger;
 import me.devnatan.inventoryframework.logging.NoopLogger;
+import me.devnatan.inventoryframework.state.TimerState;
 import org.bukkit.entity.Player;
 import org.bukkit.event.inventory.InventoryClickEvent;
 import org.bukkit.inventory.Inventory;
 import org.bukkit.inventory.InventoryHolder;
+import org.bukkit.plugin.Plugin;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -26,6 +29,12 @@ public class BukkitElementFactory extends ElementFactory {
     private static final ViewType defaultType = ViewType.CHEST;
     private Boolean worksInCurrentPlatform = null;
 
+    private final FoliaLib foliaLib;
+
+    public BukkitElementFactory(Plugin plugin) {
+        this.foliaLib = new FoliaLib(plugin);
+    }
+
     @Override
     public @NotNull RootView createUninitializedRoot() {
         return new View();
@@ -142,6 +151,12 @@ public Logger getLogger() {
 
     @Override
     public Job scheduleJobInterval(@NotNull RootView root, long intervalInTicks, @NotNull Runnable execution) {
-        return new BukkitTaskJobImpl(((View) root).getFramework().getOwner(), intervalInTicks, execution);
+        return new BukkitTaskJobImpl(foliaLib.getScheduler(), intervalInTicks, execution);
+    }
+
+    @Override
+    public TimerState createTimerState(long stateId, long intervalInTicks) {
+
+        return null;
     }
 }

inventory-framework-platform-bukkit/src/main/java/me/devnatan/inventoryframework/internal/BukkitTaskJobImpl.java

@@ -1,30 +1,30 @@
 package me.devnatan.inventoryframework.internal;
 
-import org.bukkit.plugin.Plugin;
-import org.bukkit.scheduler.BukkitTask;
+import com.tcoded.folialib.impl.PlatformScheduler;
+import com.tcoded.folialib.wrapper.task.WrappedTask;
 
 class BukkitTaskJobImpl implements Job {
 
-    private final Plugin plugin;
+    private final PlatformScheduler scheduler;
     private final long intervalInTicks;
     private final Runnable execution;
-    private BukkitTask task;
+    private WrappedTask task;
 
-    public BukkitTaskJobImpl(Plugin plugin, long intervalInTicks, Runnable execution) {
-        this.plugin = plugin;
+    public BukkitTaskJobImpl(PlatformScheduler scheduler, long intervalInTicks, Runnable execution) {
+        this.scheduler = scheduler;
         this.intervalInTicks = intervalInTicks;
         this.execution = execution;
     }
 
     @Override
     public boolean isStarted() {
-        return task != null;
+        return task != null && !task.isCancelled();
     }
 
     @Override
     public void start() {
         if (isStarted()) return;
-        task = plugin.getServer().getScheduler().runTaskTimer(plugin, this::loop, intervalInTicks, intervalInTicks);
+        task = scheduler.runTimer(this::loop, intervalInTicks, intervalInTicks);
     }
 
     @Override

inventory-framework-platform-minestom/src/main/kotlin/me/devnatan/inventoryframework/IFInventoryListener.kt

@@ -45,10 +45,7 @@ internal class IFInventoryListener(
             event.isCancelled = context.config.getOptionValue(ViewConfig.CANCEL_ON_DROP)
             return
         }
-        if (
-            event.click is Click.LeftDrag ||
-            event.click is Click.RightDrag
-        ) {
+        if (event.click is Click.LeftDrag || event.click is Click.RightDrag) {
             val context: IFContext = viewer.activeContext
             if (!context.config.isOptionSet(ViewConfig.CANCEL_ON_DRAG)) return
 

inventory-framework-platform-minestom/src/main/kotlin/me/devnatan/inventoryframework/context/SlotClickContext.kt

@@ -64,8 +64,7 @@ class SlotClickContext
 
         override fun isShiftClick(): Boolean {
             val clickType = clickOrigin.click
-            return clickType is Click.LeftShift ||
-                clickType is Click.RightShift
+            return clickType is Click.LeftShift || clickType is Click.RightShift
         }
 
         override fun isKeyboardClick(): Boolean = clickOrigin.click is Click.HotbarSwap

inventory-framework-platform-minestom/src/main/kotlin/me/devnatan/inventoryframework/internal/MinestomElementFactory.kt

@@ -91,9 +91,11 @@ class MinestomElementFactory : ElementFactory() {
                 type,
                 when (val title = config.title) {
                     is net.kyori.adventure.text.Component -> title
-                    null -> net.kyori.adventure.text.Component.empty()
+                    null ->
+                        net.kyori.adventure.text.Component
+                            .empty()
                     else -> text(title.toString())
-                }
+                },
             )
         return MinestomViewContainer(inventory, false, finalType, false)
     }

inventory-framework-platform-paper/build.gradle.kts

@@ -14,7 +14,6 @@ repositories {
 dependencies {
     compileOnly(libs.paperSpigot)
     implementation(projects.inventoryFrameworkPlatformBukkit)
-    implementation(libs.folialib)
 }
 
 java {