Interaction system

api/build.gradle.kts

@@ -8,6 +8,7 @@ dependencies {
     compileOnly("io.papermc.paper:paper-api:1.20.4-R0.1-SNAPSHOT")
 
     compileOnly("de.oliver:FancyLib:${findProperty("fancyLibVersion")}")
+    compileOnly("de.oliver.FancyAnalytics:logger:${findProperty("fancyLoggerVersion")}")
 
     implementation("me.dave:ChatColorHandler:${findProperty("chatcolorhandlerVersion")}")
 }

api/src/main/java/de/oliver/fancynpcs/api/FancyNpcsPlugin.java

@@ -1,14 +1,17 @@
 package de.oliver.fancynpcs.api;
 
+import de.oliver.fancyanalytics.logger.ExtendedFancyLogger;
 import de.oliver.fancylib.serverSoftware.schedulers.FancyScheduler;
 import de.oliver.fancylib.translations.Translator;
+import de.oliver.fancynpcs.api.actions.ActionManager;
 import de.oliver.fancynpcs.api.utils.SkinCache;
 import org.bukkit.Bukkit;
 import org.bukkit.plugin.PluginManager;
 import org.bukkit.plugin.java.JavaPlugin;
 
 import java.util.concurrent.ScheduledExecutorService;
 import java.util.function.Function;
+import java.util.logging.Logger;
 
 public interface FancyNpcsPlugin {
 
@@ -24,6 +27,10 @@ static FancyNpcsPlugin get() {
 
     JavaPlugin getPlugin();
 
+    Logger getLogger();
+
+    ExtendedFancyLogger getFancyLogger();
+
     ScheduledExecutorService getNpcThread();
 
     FancyScheduler getScheduler();
@@ -36,6 +43,8 @@ static FancyNpcsPlugin get() {
 
     AttributeManager getAttributeManager();
 
+    ActionManager getActionManager();
+
     Translator getTranslator();
 
     SkinCache getSkinCache();

api/src/main/java/de/oliver/fancynpcs/api/Npc.java

@@ -1,16 +1,14 @@
 package de.oliver.fancynpcs.api;
 
-import com.google.common.io.ByteArrayDataOutput;
-import com.google.common.io.ByteStreams;
 import de.oliver.fancylib.RandomUtils;
 import de.oliver.fancylib.translations.Translator;
+import de.oliver.fancynpcs.api.actions.ActionTrigger;
+import de.oliver.fancynpcs.api.actions.NpcAction;
+import de.oliver.fancynpcs.api.actions.executor.ActionExecutionContext;
+import de.oliver.fancynpcs.api.actions.executor.ActionExecutor;
 import de.oliver.fancynpcs.api.events.NpcInteractEvent;
-import de.oliver.fancynpcs.api.events.NpcInteractEvent.InteractionType;
 import de.oliver.fancynpcs.api.utils.Interval;
 import de.oliver.fancynpcs.api.utils.Interval.Unit;
-import me.dave.chatcolorhandler.ChatColorHandler;
-import me.dave.chatcolorhandler.ModernChatColorHandler;
-import me.dave.chatcolorhandler.parsers.custom.PlaceholderAPIParser;
 import org.bukkit.Bukkit;
 import org.bukkit.ChatColor;
 import org.bukkit.Location;
@@ -19,7 +17,6 @@
 
 import java.util.List;
 import java.util.Map;
-import java.util.Random;
 import java.util.UUID;
 import java.util.concurrent.ConcurrentHashMap;
 
@@ -144,10 +141,10 @@ public void moveForAll() {
     }
 
     public void interact(Player player) {
-        interact(player, InteractionType.CUSTOM);
+        interact(player, ActionTrigger.CUSTOM);
     }
 
-    public void interact(Player player, InteractionType interactionType) {
+    public void interact(Player player, ActionTrigger actionTrigger) {
         if (data.getInteractionCooldown() > 0) {
             final long interactionCooldownMillis = (long) (data.getInteractionCooldown() * 1000);
             final long lastInteractionMillis = lastPlayerInteraction.getOrDefault(player.getUniqueId(), 0L);
@@ -163,7 +160,8 @@ public void interact(Player player, InteractionType interactionType) {
             lastPlayerInteraction.put(player.getUniqueId(), System.currentTimeMillis());
         }
 
-        NpcInteractEvent npcInteractEvent = new NpcInteractEvent(this, data.getPlayerCommands(), data.getServerCommands(), data.getOnClick(), player, interactionType);
+        List<NpcAction.NpcActionData> actions = data.getActions(actionTrigger);
+        NpcInteractEvent npcInteractEvent = new NpcInteractEvent(this, data.getOnClick(), actions, player, actionTrigger);
         npcInteractEvent.callEvent();
 
         if (npcInteractEvent.isCancelled()) {
@@ -175,51 +173,8 @@ public void interact(Player player, InteractionType interactionType) {
             data.getOnClick().accept(player);
         }
 
-        // message
-        if (data.getMessages() != null && !data.getMessages().isEmpty()) {
-            if (data.isSendMessagesRandomly()) {
-                String randomMessage = data.getMessages().get(new Random().nextInt(data.getMessages().size()));
-                player.sendMessage(ModernChatColorHandler.translate(randomMessage, player));
-            } else {
-                for (String msg : data.getMessages()) {
-                    player.sendMessage(ModernChatColorHandler.translate(msg, player));
-                }
-            }
-        }
-
-        // serverCommand
-        for (String command : data.getServerCommands()) {
-            command = command.replace("{player}", player.getName());
-
-            String finalCommand = ChatColorHandler.translate(command, player, List.of(PlaceholderAPIParser.class));
-            FancyNpcsPlugin.get().getScheduler().runTask(null, () -> Bukkit.dispatchCommand(Bukkit.getConsoleSender(), finalCommand));
-        }
-
-        // playerCommand
-        if (data.getPlayerCommands() != null && !data.getPlayerCommands().isEmpty()) {
-            for (String cmd : data.getPlayerCommands()) {
-                String command = ChatColorHandler.translate(cmd, player, List.of(PlaceholderAPIParser.class));
-
-                if (command.toLowerCase().startsWith("server")) {
-                    String[] args = cmd.split(" ");
-                    if (args.length < 2) {
-                        return;
-                    }
-                    String server = args[1];
-
-                    ByteArrayDataOutput out = ByteStreams.newDataOutput();
-                    out.writeUTF("Connect");
-                    out.writeUTF(server);
-                    player.sendPluginMessage(FancyNpcsPlugin.get().getPlugin(), "BungeeCord", out.toByteArray());
-                    return;
-                }
-
-                FancyNpcsPlugin.get().getScheduler().runTask(
-                        player.getLocation(),
-                        () -> player.chat("/" + command)
-                );
-            }
-        }
+        // actions
+        ActionExecutor.execute(new ActionExecutionContext(actionTrigger, this, player));
     }
 
     protected abstract void refreshEntityData(Player serverPlayer);

api/src/main/java/de/oliver/fancynpcs/api/NpcData.java

@@ -1,5 +1,7 @@
 package de.oliver.fancynpcs.api;
 
+import de.oliver.fancynpcs.api.actions.ActionTrigger;
+import de.oliver.fancynpcs.api.actions.NpcAction;
 import de.oliver.fancynpcs.api.utils.NpcEquipmentSlot;
 import de.oliver.fancynpcs.api.utils.SkinFetcher;
 import net.kyori.adventure.text.format.NamedTextColor;
@@ -9,6 +11,7 @@
 import org.bukkit.inventory.ItemStack;
 
 import java.util.*;
+import java.util.concurrent.ConcurrentHashMap;
 import java.util.function.Consumer;
 
 public class NpcData {
@@ -28,11 +31,8 @@ public class NpcData {
     private EntityType type;
     private Map<NpcEquipmentSlot, ItemStack> equipment;
     private Consumer<Player> onClick;
+    private Map<ActionTrigger, List<NpcAction.NpcActionData>> actions;
     private boolean turnToPlayer;
-    private List<String> playerCommands;
-    private List<String> serverCommands;
-    private List<String> messages;
-    private boolean sendMessagesRandomly;
     private float interactionCooldown;
     private float scale;
     private Map<NpcAttribute, String> attributes;
@@ -54,10 +54,7 @@ public NpcData(
             Map<NpcEquipmentSlot, ItemStack> equipment,
             boolean turnToPlayer,
             Consumer<Player> onClick,
-            List<String> messages,
-            boolean sendMessagesRandomly,
-            List<String> serverCommands,
-            List<String> playerCommands,
+            Map<ActionTrigger, List<NpcAction.NpcActionData>> actions,
             float interactionCooldown,
             float scale,
             Map<NpcAttribute, String> attributes,
@@ -77,11 +74,8 @@ public NpcData(
         this.type = type;
         this.equipment = equipment;
         this.onClick = onClick;
+        this.actions = actions;
         this.turnToPlayer = turnToPlayer;
-        this.serverCommands = serverCommands;
-        this.playerCommands = playerCommands;
-        this.messages = messages;
-        this.sendMessagesRandomly = sendMessagesRandomly;
         this.interactionCooldown = interactionCooldown;
         this.scale = scale;
         this.attributes = attributes;
@@ -106,11 +100,8 @@ public NpcData(String name, UUID creator, Location location) {
         this.glowingColor = NamedTextColor.WHITE;
         this.onClick = p -> {
         };
+        this.actions = new ConcurrentHashMap<>();
         this.turnToPlayer = false;
-        this.messages = new ArrayList<>();
-        this.serverCommands = new ArrayList<>();
-        this.playerCommands = new ArrayList<>();
-        this.sendMessagesRandomly = false;
         this.interactionCooldown = 0;
         this.scale = 1;
         this.equipment = new HashMap<>();
@@ -248,81 +239,52 @@ public NpcData setOnClick(Consumer<Player> onClick) {
         return this;
     }
 
-    public boolean isTurnToPlayer() {
-        return turnToPlayer;
+    public Map<ActionTrigger, List<NpcAction.NpcActionData>> getActions() {
+        return actions;
     }
 
-    public NpcData setTurnToPlayer(boolean turnToPlayer) {
-        this.turnToPlayer = turnToPlayer;
+    public NpcData setActions(Map<ActionTrigger, List<NpcAction.NpcActionData>> actions) {
+        this.actions = actions;
         isDirty = true;
         return this;
     }
 
-    public List<String> getServerCommands() {
-        return serverCommands;
+    public List<NpcAction.NpcActionData> getActions(ActionTrigger trigger) {
+        return actions.getOrDefault(trigger, new ArrayList<>());
     }
 
-    public NpcData setServerCommands(List<String> serverCommands) {
-        this.serverCommands = serverCommands;
+    public NpcData setActions(ActionTrigger trigger, List<NpcAction.NpcActionData> actions) {
+        this.actions.put(trigger, actions);
         isDirty = true;
         return this;
     }
 
-    public void addServerCommand(String command) {
-        serverCommands.add(command);
-        isDirty = true;
-    }
+    public NpcData addAction(ActionTrigger trigger, int order, NpcAction action, String value) {
+        List<NpcAction.NpcActionData> a = actions.getOrDefault(trigger, new ArrayList<>());
+        a.add(new NpcAction.NpcActionData(order, action, value));
+        actions.put(trigger, a);
 
-    public void removeServerCommand(int index) {
-        serverCommands.remove(index);
-        isDirty = true;
-    }
-
-    public List<String> getPlayerCommands() {
-        return playerCommands;
-    }
-
-    public NpcData setPlayerCommands(List<String> playerCommands) {
-        this.playerCommands = playerCommands;
         isDirty = true;
         return this;
     }
 
-    public List<String> getMessages() {
-        return messages;
-    }
-
-    public NpcData setMessages(List<String> messages) {
-        this.messages = messages;
-        return this;
-    }
+    public NpcData removeAction(ActionTrigger trigger, NpcAction action) {
+        List<NpcAction.NpcActionData> a = actions.getOrDefault(trigger, new ArrayList<>());
+        a.removeIf(ad -> ad.action().equals(action));
+        actions.put(trigger, a);
 
-    public void addPlayerCommand(String command) {
-        playerCommands.add(command);
         isDirty = true;
+        return this;
     }
 
-    public void removePlayerCommand(int index) {
-        playerCommands.remove(index);
-        isDirty = true;
-    }
-
-    public boolean isSendMessagesRandomly() {
-        return sendMessagesRandomly;
-    }
-
-    public void setSendMessagesRandomly(boolean sendMessagesRandomly) {
-        this.sendMessagesRandomly = sendMessagesRandomly;
-    }
-
-    public void addMessage(String message) {
-        messages.add(message);
-        isDirty = true;
+    public boolean isTurnToPlayer() {
+        return turnToPlayer;
     }
 
-    public void removeMessage(int index) {
-        messages.remove(index);
+    public NpcData setTurnToPlayer(boolean turnToPlayer) {
+        this.turnToPlayer = turnToPlayer;
         isDirty = true;
+        return this;
     }
 
     public float getInteractionCooldown() {

api/src/main/java/de/oliver/fancynpcs/api/actions/ActionManager.java

@@ -0,0 +1,14 @@
+package de.oliver.fancynpcs.api.actions;
+
+import java.util.List;
+
+public interface ActionManager {
+
+    void registerAction(NpcAction action);
+
+    NpcAction getActionByName(String name);
+
+    void unregisterAction(NpcAction action);
+
+    List<NpcAction> getAllActions();
+}

api/src/main/java/de/oliver/fancynpcs/api/actions/ActionTrigger.java

@@ -0,0 +1,36 @@
+package de.oliver.fancynpcs.api.actions;
+
+public enum ActionTrigger {
+    /**
+     * represents any click interaction by a player.
+     */
+    ANY_CLICK,
+    /**
+     * represents a left click interaction by a player.
+     */
+    LEFT_CLICK,
+    /**
+     * represents a right click interaction by a player.
+     */
+    RIGHT_CLICK,
+    /**
+     * represents interactions invoked by the API.
+     */
+    CUSTOM,
+    ;
+
+    /**
+     * Gets the ActionTrigger by its name.
+     *
+     * @param name the name of the ActionTrigger
+     * @return the ActionTrigger or null if not found
+     */
+    public static ActionTrigger getByName(final String name) {
+        for (ActionTrigger trigger : values()) {
+            if (trigger.name().equalsIgnoreCase(name)) {
+                return trigger;
+            }
+        }
+        return null;
+    }
+}