[Feature] Sign rework api (part 1 of 2 for sign rework PR)

Movecraft/src/main/java/net/countercraft/movecraft/Movecraft.java

@@ -59,6 +59,7 @@ public class Movecraft extends JavaPlugin {
     private SmoothTeleport smoothTeleport;
     private AsyncManager asyncManager;
     private WreckManager wreckManager;
+    private AbstractSignListener abstractSignListener;
 
     public static synchronized Movecraft getInstance() {
         return instance;
@@ -132,6 +133,13 @@ public void onEnable() {
                     getLogger().warning("Falling back to bukkit teleportation provider.");
                 }
             }
+
+            // Create instance of sign listener
+            final Class<?> signListenerClass = Class.forName("net.countercraft.movecraft.compat." + WorldHandler.getPackageName(minecraftVersion) + ".SignListener");
+            if (AbstractSignListener.class.isAssignableFrom(signListenerClass)) {
+                abstractSignListener = (AbstractSignListener) signListenerClass.getConstructor().newInstance();
+                getServer().getPluginManager().registerEvents(abstractSignListener, this);
+            }
         }
         catch (final Exception e) {
             e.printStackTrace();
@@ -213,22 +221,24 @@ public void onEnable() {
         getServer().getPluginManager().registerEvents(new PlayerListener(), this);
         getServer().getPluginManager().registerEvents(new ChunkManager(), this);
         getServer().getPluginManager().registerEvents(new AscendSign(), this);
-        getServer().getPluginManager().registerEvents(new CraftSign(), this);
         getServer().getPluginManager().registerEvents(new CruiseSign(), this);
         getServer().getPluginManager().registerEvents(new DescendSign(), this);
         getServer().getPluginManager().registerEvents(new HelmSign(), this);
         getServer().getPluginManager().registerEvents(new MoveSign(), this);
         getServer().getPluginManager().registerEvents(new NameSign(), this);
         getServer().getPluginManager().registerEvents(new PilotSign(), this);
         getServer().getPluginManager().registerEvents(new RelativeMoveSign(), this);
-        getServer().getPluginManager().registerEvents(new ReleaseSign(), this);
         getServer().getPluginManager().registerEvents(new RemoteSign(), this);
         getServer().getPluginManager().registerEvents(new SpeedSign(), this);
         getServer().getPluginManager().registerEvents(new SubcraftRotateSign(), this);
         getServer().getPluginManager().registerEvents(new TeleportSign(), this);
         getServer().getPluginManager().registerEvents(new ScuttleSign(), this);
         getServer().getPluginManager().registerEvents(new CraftPilotListener(), this);
         getServer().getPluginManager().registerEvents(new CraftReleaseListener(), this);
+        getServer().getPluginManager().registerEvents(new CraftTypeListener(), this);
+
+        // Signs
+        AbstractMovecraftSign.register("Release", new ReleaseSign());
 
         var contactsManager = new ContactsManager();
         contactsManager.runTaskTimerAsynchronously(this, 0, 20);
@@ -340,4 +350,8 @@ public AsyncManager getAsyncManager() {
     public @NotNull WreckManager getWreckManager(){
         return wreckManager;
     }
+
+    public AbstractSignListener getAbstractSignListener() {
+        return abstractSignListener;
+    }
 }

Movecraft/src/main/java/net/countercraft/movecraft/craft/CraftManager.java

@@ -31,6 +31,8 @@
 import net.countercraft.movecraft.processing.effects.Effect;
 import net.countercraft.movecraft.processing.functions.CraftSupplier;
 import net.countercraft.movecraft.processing.tasks.detection.DetectionTask;
+import net.countercraft.movecraft.sign.AbstractMovecraftSign;
+import net.countercraft.movecraft.sign.CraftPilotSign;
 import net.kyori.adventure.audience.Audience;
 import net.kyori.adventure.text.Component;
 import org.bukkit.Bukkit;
@@ -96,6 +98,9 @@ private CraftManager(boolean loadCraftTypes) {
             craftTypes = loadCraftTypes();
         else
             craftTypes = new HashSet<>();
+
+        // Since the event is only created in reload cases...
+        AbstractMovecraftSign.registerCraftPilotSigns(CraftManager.getInstance().getCraftTypes(), CraftPilotSign::new);
     }
 
     @NotNull

Movecraft/src/main/java/net/countercraft/movecraft/listener/CraftTypeListener.java

@@ -0,0 +1,17 @@
+package net.countercraft.movecraft.listener;
+
+import net.countercraft.movecraft.craft.CraftManager;
+import net.countercraft.movecraft.events.TypesReloadedEvent;
+import net.countercraft.movecraft.sign.AbstractMovecraftSign;
+import net.countercraft.movecraft.sign.CraftPilotSign;
+import org.bukkit.event.EventHandler;
+import org.bukkit.event.Listener;
+
+public class CraftTypeListener implements Listener {
+
+    @EventHandler
+    public void onReload(TypesReloadedEvent event) {
+        AbstractMovecraftSign.registerCraftPilotSigns(CraftManager.getInstance().getCraftTypes(), CraftPilotSign::new);
+    }
+
+}

Movecraft/src/main/java/net/countercraft/movecraft/sign/CraftSign.java → Movecraft/src/main/java/net/countercraft/movecraft/sign/CraftPilotSign.java

@@ -4,89 +4,85 @@
 import net.countercraft.movecraft.Movecraft;
 import net.countercraft.movecraft.MovecraftLocation;
 import net.countercraft.movecraft.config.Settings;
-import net.countercraft.movecraft.craft.Craft;
-import net.countercraft.movecraft.craft.CraftManager;
-import net.countercraft.movecraft.craft.CruiseOnPilotCraft;
-import net.countercraft.movecraft.craft.CruiseOnPilotSubCraft;
-import net.countercraft.movecraft.craft.PlayerCraftImpl;
-import net.countercraft.movecraft.craft.SubCraft;
+import net.countercraft.movecraft.craft.*;
 import net.countercraft.movecraft.craft.type.CraftType;
 import net.countercraft.movecraft.events.CraftPilotEvent;
 import net.countercraft.movecraft.events.CraftReleaseEvent;
 import net.countercraft.movecraft.localisation.I18nSupport;
 import net.countercraft.movecraft.processing.functions.Result;
 import net.countercraft.movecraft.util.Pair;
 import org.bukkit.Bukkit;
-import org.bukkit.ChatColor;
 import org.bukkit.Location;
 import org.bukkit.World;
-import org.bukkit.block.BlockState;
-import org.bukkit.block.Sign;
-import org.bukkit.block.data.Directional;
+import org.bukkit.block.BlockFace;
 import org.bukkit.entity.Player;
-import org.bukkit.event.EventHandler;
-import org.bukkit.event.EventPriority;
-import org.bukkit.event.Listener;
 import org.bukkit.event.block.Action;
 import org.bukkit.event.block.SignChangeEvent;
-import org.bukkit.event.player.PlayerInteractEvent;
 import org.bukkit.scheduler.BukkitRunnable;
-import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
+import java.util.Collections;
 import java.util.HashSet;
+import java.util.Optional;
 import java.util.Set;
 
-public final class CraftSign implements Listener {
-    private final Set<MovecraftLocation> piloting = new HashSet<>();
+//TODO: This is not very pretty...
+public class CraftPilotSign extends AbstractCraftPilotSign {
 
-    @EventHandler(priority = EventPriority.NORMAL, ignoreCancelled = true)
-    public void onSignChange(@NotNull SignChangeEvent event) {
-        if (CraftManager.getInstance().getCraftTypeFromString(event.getLine(0)) == null)
-            return;
+    static final Set<MovecraftLocation> PILOTING = Collections.synchronizedSet(new HashSet<>());
 
-        if (!Settings.RequireCreatePerm)
-            return;
-
-        if (!event.getPlayer().hasPermission("movecraft." + ChatColor.stripColor(event.getLine(0)) + ".create")) {
-            event.getPlayer().sendMessage(I18nSupport.getInternationalisedString("Insufficient Permissions"));
-            event.setCancelled(true);
-        }
+    public CraftPilotSign(CraftType craftType) {
+        super(craftType);
     }
 
-    @EventHandler(priority = EventPriority.LOW, ignoreCancelled = true)
-    public void onSignClick(@NotNull PlayerInteractEvent event) {
-        if (event.getAction() != Action.RIGHT_CLICK_BLOCK || event.getClickedBlock() == null)
-            return;
-
-        BlockState state = event.getClickedBlock().getState();
-        if (!(state instanceof Sign))
-            return;
-
-        Sign sign = (Sign) state;
-        CraftType craftType = CraftManager.getInstance().getCraftTypeFromString(ChatColor.stripColor(sign.getLine(0)));
-        if (craftType == null)
-            return;
+    @Override
+    public boolean shouldCancelEvent(boolean processingSuccessful, @Nullable Action type, boolean sneaking) {
+        return processingSuccessful || !sneaking;
+    }
 
-        // Valid sign prompt for ship command.
-        event.setCancelled(true);
-        Player player = event.getPlayer();
-        if (!player.hasPermission("movecraft." + ChatColor.stripColor(sign.getLine(0)) + ".pilot")) {
+    @Override
+    protected boolean isSignValid(Action clickType, AbstractSignListener.SignWrapper sign, Player player) {
+        String header = sign.getRaw(0).trim();
+        CraftType craftType = CraftManager.getInstance().getCraftTypeFromString(header);
+        if (craftType != this.craftType) {
+            return false;
+        }
+        if (!player.hasPermission("movecraft." + header + ".pilot")) {
             player.sendMessage(I18nSupport.getInternationalisedString("Insufficient Permissions"));
-            return;
+            return false;
+        } else {
+            return true;
         }
+    }
 
-        Location loc = event.getClickedBlock().getLocation();
+    @Override
+    protected boolean internalProcessSign(Action clickType, AbstractSignListener.SignWrapper sign, Player player, @javax.annotation.Nullable Craft craft) {
+        if (this.craftType.getBoolProperty(CraftType.MUST_BE_SUBCRAFT) && craft == null) {
+            return false;
+        }
+        World world = sign.block().getWorld();
+        if (craft != null) {
+            world = craft.getWorld();
+        }
+        Location loc = sign.block().getLocation();
         MovecraftLocation startPoint = new MovecraftLocation(loc.getBlockX(), loc.getBlockY(), loc.getBlockZ());
-        if (piloting.contains(startPoint)) {
-            return;
+
+        if (PILOTING.contains(startPoint)) {
+            // Always return true
+            return true;
         }
 
-        // Attempt to run detection
-        World world = event.getClickedBlock().getWorld();
+        runDetectTask(startPoint, player, sign, craft, world);
+
+        return true;
+    }
 
+    protected void runDetectTask(MovecraftLocation startPoint, Player player, AbstractSignListener.SignWrapper signWrapper, Craft parentCraft, World world) {
+        PILOTING.add(startPoint);
         CraftManager.getInstance().detect(
                 startPoint,
                 craftType, (type, w, p, parents) -> {
+                    // Assert instructions are not available normally, also this is checked in beforehand sort of
                     assert p != null; // Note: This only passes in a non-null player.
                     if (type.getBoolProperty(CraftType.CRUISE_ON_PILOT)) {
                         if (parents.size() > 1)
@@ -122,10 +118,12 @@ public void onSignClick(@NotNull PlayerInteractEvent event) {
 
                     if (craft.getType().getBoolProperty(CraftType.CRUISE_ON_PILOT)) {
                         // Setup cruise direction
-                        if (sign.getBlockData() instanceof Directional)
+                        BlockFace facing = signWrapper.facing();
+                        craft.setCruiseDirection(CruiseDirection.fromBlockFace(facing));
+                        /*if (signWrapper.block().getBlockData() instanceof Directional)
                             craft.setCruiseDirection(CruiseDirection.fromBlockFace(((Directional) sign.getBlockData()).getFacing()));
                         else
-                            craft.setCruiseDirection(CruiseDirection.NONE);
+                            craft.setCruiseDirection(CruiseDirection.NONE);*/
 
                         // Start craft cruising
                         craft.setLastCruiseUpdate(System.currentTimeMillis());
@@ -148,11 +146,34 @@ public void run() {
                     }
                 }
         );
+        // TODO: Move this to be directly called by the craftmanager post detection...
+        // Or use the event handler or something
         new BukkitRunnable() {
             @Override
             public void run() {
-                piloting.remove(startPoint);
+                PILOTING.remove(startPoint);
             }
         }.runTaskLater(Movecraft.getInstance(), 4);
+
+    }
+
+    @Override
+    public boolean processSignChange(SignChangeEvent event, AbstractSignListener.SignWrapper sign) {
+        String header = sign.getRaw(0).trim();
+        CraftType craftType = CraftManager.getInstance().getCraftTypeFromString(header);
+        if (craftType != this.craftType) {
+            return false;
+        }
+        if (Settings.RequireCreatePerm) {
+            Player player = event.getPlayer();
+            if (!player.hasPermission("movecraft." + header + ".create")) {
+                player.sendMessage(I18nSupport.getInternationalisedString("Insufficient Permissions"));
+                return false;
+            } else {
+                return true;
+            }
+        } else {
+            return true;
+        }
     }
 }

Movecraft/src/main/java/net/countercraft/movecraft/sign/ReleaseSign.java

@@ -3,37 +3,44 @@
 import net.countercraft.movecraft.craft.Craft;
 import net.countercraft.movecraft.craft.CraftManager;
 import net.countercraft.movecraft.events.CraftReleaseEvent;
-import org.bukkit.ChatColor;
-import org.bukkit.block.BlockState;
-import org.bukkit.block.Sign;
-import org.bukkit.event.EventHandler;
-import org.bukkit.event.EventPriority;
-import org.bukkit.event.Listener;
+import org.bukkit.entity.Player;
 import org.bukkit.event.block.Action;
-import org.bukkit.event.player.PlayerInteractEvent;
-import org.jetbrains.annotations.NotNull;
+import org.bukkit.event.block.SignChangeEvent;
+import org.jetbrains.annotations.Nullable;
 
-public final class ReleaseSign implements Listener{
-    private static final String HEADER = "Release";
+public class ReleaseSign extends AbstractMovecraftSign {
 
-    @EventHandler(priority = EventPriority.NORMAL, ignoreCancelled = true)
-    public void onSignClick(@NotNull PlayerInteractEvent event) {
-        if (event.getAction() != Action.RIGHT_CLICK_BLOCK) {
-            return;
-        }
-        BlockState state = event.getClickedBlock().getState();
-        if (!(state instanceof Sign)) {
-            return;
-        }
-        Sign sign = (Sign) state;
-        if (!ChatColor.stripColor(sign.getLine(0)).equalsIgnoreCase(HEADER)) {
-            return;
+    public ReleaseSign() {
+        super(null);
+    }
+
+    @Override
+    public boolean shouldCancelEvent(boolean processingSuccessful, @Nullable Action type, boolean sneaking) {
+        if (processingSuccessful) {
+            return true;
         }
-        event.setCancelled(true);
-        Craft craft = CraftManager.getInstance().getCraftByPlayer(event.getPlayer());
+        return !sneaking;
+    }
+
+    @Override
+    protected boolean isSignValid(Action clickType, AbstractSignListener.SignWrapper sign, Player player) {
+        return true;
+    }
+
+    @Override
+    protected boolean internalProcessSign(Action clickType, AbstractSignListener.SignWrapper sign, Player player, @Nullable Craft craft) {
         if (craft == null) {
-            return;
+            craft = CraftManager.getInstance().getCraftByPlayer(player);
+        }
+        if (craft != null) {
+            CraftManager.getInstance().release(craft, CraftReleaseEvent.Reason.PLAYER, false);
         }
-        CraftManager.getInstance().release(craft, CraftReleaseEvent.Reason.PLAYER, false);
+        return true;
     }
+
+    @Override
+    public boolean processSignChange(SignChangeEvent event, AbstractSignListener.SignWrapper sign) {
+        return false;
+    }
+
 }

api/src/main/java/net/countercraft/movecraft/MovecraftRotation.java

@@ -17,6 +17,21 @@
 
 package net.countercraft.movecraft;
 
+import org.bukkit.event.block.Action;
+
 public enum MovecraftRotation {
-    CLOCKWISE, NONE, ANTICLOCKWISE
+    CLOCKWISE, NONE, ANTICLOCKWISE;
+
+	public static MovecraftRotation fromAction(Action clickType) {
+        switch (clickType) {
+            case LEFT_CLICK_AIR:
+            case LEFT_CLICK_BLOCK:
+                return ANTICLOCKWISE;
+            case RIGHT_CLICK_AIR:
+            case RIGHT_CLICK_BLOCK:
+                return CLOCKWISE;
+            default:
+                return NONE;
+        }
+    }
 }