Implement MythicMobs dealdamage task type

Closes https://github.com/LMBishop/Quests/issues/768

3 files changed, 237 insertions, 2 deletions

diff --git a/bukkit/src/main/java/com/leonardobishop/quests/bukkit/BukkitQuestsPlugin.java b/bukkit/src/main/java/com/leonardobishop/quests/bukkit/BukkitQuestsPlugin.java
index cf0aabb4..00920e77 100644
--- a/bukkit/src/main/java/com/leonardobishop/quests/bukkit/BukkitQuestsPlugin.java
+++ b/bukkit/src/main/java/com/leonardobishop/quests/bukkit/BukkitQuestsPlugin.java
@@ -127,6 +127,7 @@ import com.leonardobishop.quests.bukkit.tasktype.type.dependent.FabledSkyBlockLe
 import com.leonardobishop.quests.bukkit.tasktype.type.dependent.FancyNpcsDeliverTaskType;
 import com.leonardobishop.quests.bukkit.tasktype.type.dependent.FancyNpcsInteractTaskType;
 import com.leonardobishop.quests.bukkit.tasktype.type.dependent.IridiumSkyblockValueTaskType;
+import com.leonardobishop.quests.bukkit.tasktype.type.dependent.MythicMobsDealDamageTaskType;
 import com.leonardobishop.quests.bukkit.tasktype.type.dependent.MythicMobsKillingTaskType;
 import com.leonardobishop.quests.bukkit.tasktype.type.dependent.NuVotifierVoteTaskType;
 import com.leonardobishop.quests.bukkit.tasktype.type.dependent.PinataPartyHitTaskType;
@@ -189,6 +190,7 @@ import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.function.BiFunction;
+import java.util.function.BooleanSupplier;
 import java.util.logging.Level;
 import java.util.regex.Pattern;
 
@@ -533,10 +535,12 @@ public class BukkitQuestsPlugin extends JavaPlugin implements Quests {
                 String pluginVersion = CompatUtils.getPluginVersion("IridiumSkyblock");
                 return pluginVersion != null && pluginVersion.startsWith("2");
             });
-            taskTypeManager.registerTaskType(() -> new MythicMobsKillingTaskType(this), () -> {
+            BooleanSupplier mythicMobsCompat = () -> {
                 String pluginVersion = CompatUtils.getPluginVersion("MythicMobs");
                 return pluginVersion != null && (pluginVersion.startsWith("4") || pluginVersion.startsWith("5"));
-            });
+            };
+            taskTypeManager.registerTaskType(() -> new MythicMobsDealDamageTaskType(this), mythicMobsCompat);
+            taskTypeManager.registerTaskType(() -> new MythicMobsKillingTaskType(this), mythicMobsCompat);
 
             // Close task type registrations
             taskTypeManager.closeRegistrations();
diff --git a/bukkit/src/main/java/com/leonardobishop/quests/bukkit/tasktype/type/dependent/MythicMobsDealDamageTaskType.java b/bukkit/src/main/java/com/leonardobishop/quests/bukkit/tasktype/type/dependent/MythicMobsDealDamageTaskType.java
new file mode 100644
index 00000000..cdd4578d
--- /dev/null
+++ b/bukkit/src/main/java/com/leonardobishop/quests/bukkit/tasktype/type/dependent/MythicMobsDealDamageTaskType.java
@@ -0,0 +1,188 @@
+package com.leonardobishop.quests.bukkit.tasktype.type.dependent;
+
+import com.google.common.collect.HashBasedTable;
+import com.google.common.collect.Table;
+import com.leonardobishop.quests.bukkit.BukkitQuestsPlugin;
+import com.leonardobishop.quests.bukkit.item.QuestItem;
+import com.leonardobishop.quests.bukkit.tasktype.BukkitTaskType;
+import com.leonardobishop.quests.bukkit.util.CompatUtils;
+import com.leonardobishop.quests.bukkit.util.TaskUtils;
+import com.leonardobishop.quests.bukkit.util.constraint.TaskConstraintSet;
+import com.leonardobishop.quests.common.player.QPlayer;
+import com.leonardobishop.quests.common.player.questprogressfile.TaskProgress;
+import com.leonardobishop.quests.common.quest.Quest;
+import com.leonardobishop.quests.common.quest.Task;
+import io.lumine.mythic.bukkit.MythicBukkit;
+import io.lumine.xikage.mythicmobs.MythicMobs;
+import org.bukkit.entity.Damageable;
+import org.bukkit.entity.Entity;
+import org.bukkit.entity.Player;
+import org.bukkit.event.EventHandler;
+import org.bukkit.event.EventPriority;
+import org.bukkit.event.entity.EntityDamageEvent;
+import org.bukkit.inventory.ItemStack;
+import org.jspecify.annotations.NullMarked;
+
+import java.util.function.BiConsumer;
+
+@NullMarked
+public final class MythicMobsDealDamageTaskType extends BukkitTaskType {
+
+    private final BukkitQuestsPlugin plugin;
+    private final Table<String, String, QuestItem> fixedQuestItemCache;
+    private final BiConsumer<Entity, BiConsumer<String, Double>> entityConsumer;
+
+    public MythicMobsDealDamageTaskType(final BukkitQuestsPlugin plugin) {
+        super("mythicmobs_dealdamage", TaskUtils.TASK_ATTRIBUTION_STRING, "Deal damage to specified MythicMobs mob.");
+
+        this.plugin = plugin;
+        this.fixedQuestItemCache = HashBasedTable.create();
+
+        // MythicMobs 5
+        if (CompatUtils.classExists("io.lumine.mythic.bukkit.MythicBukkit")) {
+            entityConsumer = (entity, consumer) -> {
+                //noinspection resource
+                io.lumine.mythic.core.mobs.ActiveMob mob = MythicBukkit.inst()
+                        .getMobManager()
+                        .getActiveMob(entity.getUniqueId())
+                        .orElse(null);
+
+                if (mob == null) {
+                    return;
+                }
+
+                String mobName = mob.getMobType();
+                double level = mob.getLevel();
+
+                consumer.accept(mobName, level);
+            };
+
+            return;
+        }
+
+        // MythicMobs 4
+        if (CompatUtils.classExists("io.lumine.xikage.mythicmobs.MythicMobs")) {
+            entityConsumer = (entity, consumer) -> {
+                //noinspection resource
+                io.lumine.xikage.mythicmobs.mobs.ActiveMob mob = MythicMobs.inst()
+                        .getMobManager()
+                        .getActiveMob(entity.getUniqueId())
+                        .orElse(null);
+
+                if (mob == null) {
+                    return;
+                }
+
+                String mobName = mob.getMobType();
+                double level = mob.getLevel();
+
+                consumer.accept(mobName, level);
+            };
+
+            return;
+        }
+
+        plugin.getLogger().severe("Failed to register event handler for MythicMobs dealdamage task type!");
+        plugin.getLogger().severe("MythicMobs version detected: " + CompatUtils.getPluginVersion("MythicMobs"));
+
+        // By default, do nothing
+        entityConsumer = (entity, consumer) -> {};
+    }
+
+    @Override
+    public void onReady() {
+        fixedQuestItemCache.clear();
+    }
+
+    @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true)
+    public void onEntityDamage(EntityDamageEvent event) {
+        entityConsumer.accept(event.getEntity(), (mobName, level) -> this.handle(event, mobName, level));
+    }
+
+    private void handle(final EntityDamageEvent event, final String mobName, final double level) {
+        Entity entity = event.getEntity();
+        Player player = plugin.getVersionSpecificHandler().getDamager(event);
+
+        if (player == null || player.hasMetadata("NPC")) {
+            return;
+        }
+
+        QPlayer qPlayer = plugin.getPlayerManager().getPlayer(player.getUniqueId());
+        if (qPlayer == null) {
+            return;
+        }
+
+        if (!(entity instanceof Damageable damageable)) {
+            return;
+        }
+
+        // Clamp entity damage as getDamage() returns Float.MAX_VALUE for killing a parrot with a cookie
+        // https://github.com/LMBishop/Quests/issues/753
+        double finalDamage = event.getFinalDamage();
+        double health = damageable.getHealth();
+        double damage = Math.clamp(finalDamage, 0.0d, health);
+
+        for (TaskUtils.PendingTask pendingTask : TaskUtils.getApplicableTasks(player, qPlayer, this, TaskConstraintSet.ALL)) {
+            Quest quest = pendingTask.quest();
+            Task task = pendingTask.task();
+            TaskProgress taskProgress = pendingTask.taskProgress();
+
+            super.debug("Player damaged " + mobName + " for " + damage, quest.getId(), task.getId(), player.getUniqueId());
+
+            if (!TaskUtils.matchString(this, pendingTask, mobName, player.getUniqueId(), "name", "names", false, "name-match-mode", false)) {
+                super.debug("Continuing...", quest.getId(), task.getId(), player.getUniqueId());
+                continue;
+            }
+
+            int minMobLevel = (int) task.getConfigValue("min-level", -1);
+            if (level < minMobLevel) {
+                super.debug("Minimum level is required and it is not high enough, continuing...", quest.getId(), task.getId(), player.getUniqueId());
+                continue;
+            }
+
+            int requiredLevel = (int) task.getConfigValue("level", -1);
+            if (requiredLevel != -1 && level != requiredLevel) {
+                super.debug("Specific level is required and it does not match, continuing...", quest.getId(), task.getId(), player.getUniqueId());
+                continue;
+            }
+
+            if (task.hasConfigKey("item")) {
+                ItemStack item = plugin.getVersionSpecificHandler().getItemInMainHand(player);
+                if (item == null) {
+                    super.debug("Specific item is required, player has no item in hand; continuing...", quest.getId(), task.getId(), player.getUniqueId());
+                    continue;
+                }
+
+                super.debug("Specific item is required; player held item is of type '" + item.getType() + "'", quest.getId(), task.getId(), player.getUniqueId());
+
+                QuestItem qi;
+                if ((qi = fixedQuestItemCache.get(quest.getId(), task.getId())) == null) {
+                    QuestItem fetchedItem = TaskUtils.getConfigQuestItem(task, "item", "data");
+                    fixedQuestItemCache.put(quest.getId(), task.getId(), fetchedItem);
+                    qi = fetchedItem;
+                }
+
+                boolean exactMatch = TaskUtils.getConfigBoolean(task, "exact-match", true);
+                if (!qi.compareItemStack(item, exactMatch)) {
+                    super.debug("Item does not match required item, continuing...", quest.getId(), task.getId(), player.getUniqueId());
+                    continue;
+                } else {
+                    super.debug("Item matches required item", quest.getId(), task.getId(), player.getUniqueId());
+                }
+            }
+
+            int amount = (int) task.getConfigValue("amount");
+            double progress = Math.min(amount, TaskUtils.getDecimalTaskProgress(taskProgress) + damage);
+
+            taskProgress.setProgress(progress);
+            super.debug("Updating task progress (now " + progress + ")", quest.getId(), task.getId(), player.getUniqueId());
+
+            if (progress >= amount) {
+                super.debug("Marking task as complete", quest.getId(), task.getId(), player.getUniqueId());
+                taskProgress.setCompleted(true);
+            }
+
+            TaskUtils.sendTrackAdvancement(player, quest, task, pendingTask, amount);
+        }
+    }
+}
diff --git a/docs/task-types/mythicmobs_dealdamage-(task-type).md b/docs/task-types/mythicmobs_dealdamage-(task-type).md
new file mode 100644
index 00000000..d2594308
--- /dev/null
+++ b/docs/task-types/mythicmobs_dealdamage-(task-type).md
@@ -0,0 +1,43 @@
+---
+title: mythicmobs_dealdamage
+parent: External task types
+grand_parent: Task types
+---
+
+# mythicmobs_dealdamage (task type)
+
+Not released yet (dev builds)
+{: .label .label-green }
+
+Plugin 'MythicMobs' required
+{: .label }
+
+Deal a certain amount of damage to a MythicMobs mob.
+
+## Options
+
+| Key               | Description                                            | Type                | Required | Default | Notes                                                                                                    |
+|-------------------|--------------------------------------------------------|---------------------|----------|---------|----------------------------------------------------------------------------------------------------------|
+| `amount`          | The amount of damage needed.                           | Integer             | Yes      | \-      | Damage is measured in HP, 1 heart = 2 HP. A player has 20 HP by default, with no status effects applied. |
+| `name` / `names`  | The MythicMob ID.                                      | String              | Yes      | \-      | \-                                                                                                       |
+| `name-match-mode` | The match mode to be used to compare the strings       | String              | No       | EQUALS  | One of: `EQUALS`, `STARTS_WITH`, `ENDS_WITH`.                                                            |
+| `level`           | The level the mob must be at.                          | Integer             | Yes      | \-      | \-                                                                                                       |
+| `min-level`       | The minimum level the mob must be at.                  | Integer             | Yes      | \-      | \-                                                                                                       |
+| `item`            | Specific item which should be used to deal damage.     | ItemStack           | No       | \-      | Accepts standard [item definition](../configuration/defining-items).                                     |
+| `data`            | The data code for the item.                            | Integer             | No       | 0       | This field is not used in Minecraft versions 1.13+, nor is it compatible with ItemStack definitions.     |
+| `exact-match`     | Whether the item should exactly match what is defined. | Boolean             | No       | true    | \-                                                                                                       |
+| `worlds`          | Worlds which should count towards the progress.        | List of world names | No       | \-      | \-                                                                                                       |
+
+## Examples
+
+Deal 200 damage to a mythic mob with the ID "SkeletalKnight" of at least level 3:
+
+``` yaml
+mythicmobs:
+  type: "mythicmobs_dealdamage"
+  amount: 200                           # amount of damage to be dealt
+  name: "SkeletalKnight"                # internal name of mob (name in config - NOT display name)
+  min-level: 3                          # (OPTIONAL) the minimum level the mob must be for it to count
+  worlds:                               # (OPTIONAL) restrict to certain worlds
+   - "world"
+```