fix: check if backpack armorstand is a valid entity before update

build.gradle.kts

@@ -8,7 +8,7 @@ plugins {
 }
 
 group = "com.hibiscusmc"
-version = "2.2.5-DEV"
+version = "2.2.5"
 
 allprojects {
     apply(plugin = "java")

common/src/main/java/com/hibiscusmc/hmccosmetics/api/PlayerEmoteStartEvent.java

@@ -0,0 +1,50 @@
+package com.hibiscusmc.hmccosmetics.api;
+
+import com.hibiscusmc.hmccosmetics.user.CosmeticUser;
+import org.bukkit.event.Cancellable;
+import org.bukkit.event.Event;
+import org.bukkit.event.HandlerList;
+import org.jetbrains.annotations.NotNull;
+
+public class PlayerEmoteStartEvent extends Event implements Cancellable {
+
+    private final CosmeticUser user;
+    private String animationId; // Animation id can be invalid!
+    private boolean isCancelled;
+
+    public PlayerEmoteStartEvent(CosmeticUser user, String animationId) {
+        this.user = user;
+        this.animationId = animationId;
+        this.isCancelled = false;
+    }
+
+    @Override
+    public boolean isCancelled() {
+        return isCancelled;
+    }
+
+    @Override
+    public void setCancelled(boolean cancel) {
+        isCancelled = cancel;
+    }
+
+    private static final HandlerList handlers = new HandlerList();
+
+    @Override
+    @NotNull
+    public HandlerList getHandlers() {
+        return handlers;
+    }
+
+    public static HandlerList getHandlerList() {
+        return handlers;
+    }
+
+    public CosmeticUser getUser() {
+        return user;
+    }
+
+    public String getAnimationId() {
+        return animationId;
+    }
+}

common/src/main/java/com/hibiscusmc/hmccosmetics/api/PlayerEmoteStopEvent.java

@@ -0,0 +1,51 @@
+package com.hibiscusmc.hmccosmetics.api;
+
+import com.hibiscusmc.hmccosmetics.user.CosmeticUser;
+import com.hibiscusmc.hmccosmetics.user.manager.UserEmoteManager;
+import org.bukkit.event.Cancellable;
+import org.bukkit.event.Event;
+import org.bukkit.event.HandlerList;
+import org.jetbrains.annotations.NotNull;
+
+public class PlayerEmoteStopEvent extends Event implements Cancellable {
+
+    private final CosmeticUser user;
+    private final UserEmoteManager.StopEmoteReason stopEmoteReason;
+    private boolean isCancelled;
+
+    public PlayerEmoteStopEvent(CosmeticUser user, UserEmoteManager.StopEmoteReason reason) {
+        this.user = user;
+        this.stopEmoteReason = reason;
+        this.isCancelled = false;
+    }
+
+    @Override
+    public boolean isCancelled() {
+        return isCancelled;
+    }
+
+    @Override
+    public void setCancelled(boolean cancel) {
+        isCancelled = cancel;
+    }
+
+    private static final HandlerList handlers = new HandlerList();
+
+    @Override
+    @NotNull
+    public HandlerList getHandlers() {
+        return handlers;
+    }
+
+    public static HandlerList getHandlerList() {
+        return handlers;
+    }
+
+    public CosmeticUser getUser() {
+        return user;
+    }
+
+    public UserEmoteManager.StopEmoteReason getStopEmoteReason() {
+        return stopEmoteReason;
+    }
+}

common/src/main/java/com/hibiscusmc/hmccosmetics/config/Settings.java

@@ -36,6 +36,12 @@ public class Settings {
     private static final String HOOK_ITEMADDER_PATH = "itemsadder";
     private static final String HOOK_RELOAD_CHANGE_PATH = "reload-on-change";
     private static final String COSMETIC_EMOTE_CHECK_PATH = "emote-block-check";
+    private static final String COSMETIC_EMOTE_DAMAGE_PATH = "emote-damage-leave";
+    private static final String COSMETIC_EMOTE_INVINCIBLE_PATH = "emote-invincible";
+    private static final String COSMETIC_ADD_ENCHANTS_HELMET_PATH = "helmet-add-enchantments";
+    private static final String COSMETIC_ADD_ENCHANTS_CHESTPLATE_PATH = "chest-add-enchantments";
+    private static final String COSMETIC_ADD_ENCHANTS_LEGGINGS_PATH = "leggings-add-enchantments";
+    private static final String COSMETIC_ADD_ENCHANTS_BOOTS_PATH = "boots-add-enchantments";
 
     private static String defaultMenu;
     private static String dyeMenuName;
@@ -52,6 +58,12 @@ public class Settings {
     private static boolean forcePermissionJoin;
     private static boolean itemsAdderChangeReload;
     private static boolean cosmeticEmoteBlockCheck;
+    private static boolean addHelmetEnchants;
+    private static boolean addChestplateEnchants;
+    private static boolean addLeggingEnchants;
+    private static boolean addBootsEnchants;
+    private static boolean emoteDamageLeave;
+    private static boolean emoteInvincible;
     private static int lookDownPitch;
     private static int viewDistance;
     private static int tickPeriod;
@@ -84,6 +96,12 @@ public class Settings {
         forcePermissionJoin = cosmeticSettings.node(FORCE_PERMISSION_JOIN_PATH).getBoolean(false);
         emoteDistance = cosmeticSettings.node(EMOTE_DISTANCE_PATH).getDouble(-3);
         cosmeticEmoteBlockCheck = cosmeticSettings.node(COSMETIC_EMOTE_CHECK_PATH).getBoolean(true);
+        emoteDamageLeave = cosmeticSettings.node(COSMETIC_EMOTE_DAMAGE_PATH).getBoolean(false);
+        emoteInvincible = cosmeticSettings.node(COSMETIC_EMOTE_INVINCIBLE_PATH).getBoolean(false);
+        addHelmetEnchants = cosmeticSettings.node(COSMETIC_ADD_ENCHANTS_HELMET_PATH).getBoolean(false);
+        addChestplateEnchants = cosmeticSettings.node(COSMETIC_ADD_ENCHANTS_CHESTPLATE_PATH).getBoolean(false);
+        addLeggingEnchants = cosmeticSettings.node(COSMETIC_ADD_ENCHANTS_LEGGINGS_PATH).getBoolean(false);
+        addBootsEnchants = cosmeticSettings.node(COSMETIC_ADD_ENCHANTS_BOOTS_PATH).getBoolean(false);
 
         tickPeriod = cosmeticSettings.node(TICK_PERIOD_PATH).getInt(-1);
         lookDownPitch = cosmeticSettings.node(LOOK_DOWN_PITCH_PATH).getInt();
@@ -227,6 +245,34 @@ public class Settings {
         return cosmeticEmoteBlockCheck;
     }
 
+    public static boolean isEmoteDamageLeave() {
+        return emoteDamageLeave;
+    }
+
+    public static boolean isEmoteInvincible() {
+        return emoteInvincible;
+    }
+
+    public static boolean getShouldAddEnchants(EquipmentSlot slot) {
+        switch (slot) {
+            case HEAD -> {
+                return addHelmetEnchants;
+            }
+            case CHEST -> {
+                return addChestplateEnchants;
+            }
+            case LEGS -> {
+                return addLeggingEnchants;
+            }
+            case FEET -> {
+                return addBootsEnchants;
+            }
+            default -> {
+                return false;
+            }
+        }
+    }
+
     public static void setDebugMode(boolean newSetting) {
         debugMode = newSetting;
 

common/src/main/java/com/hibiscusmc/hmccosmetics/cosmetic/types/CosmeticArmorType.java

@@ -1,12 +1,16 @@
 package com.hibiscusmc.hmccosmetics.cosmetic.types;
 
+import com.hibiscusmc.hmccosmetics.config.Settings;
 import com.hibiscusmc.hmccosmetics.cosmetic.Cosmetic;
+import com.hibiscusmc.hmccosmetics.nms.NMSHandlers;
 import com.hibiscusmc.hmccosmetics.user.CosmeticUser;
 import com.hibiscusmc.hmccosmetics.util.InventoryUtils;
+import com.hibiscusmc.hmccosmetics.util.MessagesUtil;
 import com.hibiscusmc.hmccosmetics.util.packets.PacketManager;
 import org.bukkit.Bukkit;
 import org.bukkit.entity.Player;
 import org.bukkit.inventory.EquipmentSlot;
+import org.bukkit.inventory.ItemStack;
 import org.jetbrains.annotations.NotNull;
 import org.spongepowered.configurate.ConfigurationNode;
 
@@ -24,10 +28,17 @@ public class CosmeticArmorType extends Cosmetic {
     public void update(@NotNull CosmeticUser user) {
         Player player = Bukkit.getPlayer(user.getUniqueId());
         if (player == null) return;
+        ItemStack cosmeticItem = user.getUserCosmeticItem(this);
         if (equipSlot.equals(EquipmentSlot.OFF_HAND)) {
             if (!player.getInventory().getItemInOffHand().getType().isAir()) return;
         }
-        PacketManager.equipmentSlotUpdate(player, getSlot(), PacketManager.getViewers(player.getLocation()));
+        ItemStack equippedItem = player.getInventory().getItem(equipSlot);
+        if (Settings.getShouldAddEnchants(equipSlot)) {
+            cosmeticItem.addUnsafeEnchantments(equippedItem.getEnchantments());
+        }
+
+        NMSHandlers.getHandler().equipmentSlotUpdate(player.getEntityId(), equipSlot, cosmeticItem, PacketManager.getViewers(player.getLocation()));
+        //PacketManager.equipmentSlotUpdate(player, getSlot(), PacketManager.getViewers(player.getLocation())); Old method
     }
 
     public EquipmentSlot getEquipSlot() {

common/src/main/java/com/hibiscusmc/hmccosmetics/cosmetic/types/CosmeticBackpackType.java

@@ -3,6 +3,7 @@ package com.hibiscusmc.hmccosmetics.cosmetic.types;
 import com.hibiscusmc.hmccosmetics.cosmetic.Cosmetic;
 import com.hibiscusmc.hmccosmetics.user.CosmeticUser;
 import com.hibiscusmc.hmccosmetics.user.manager.UserBackpackManager;
+import com.hibiscusmc.hmccosmetics.util.MessagesUtil;
 import com.hibiscusmc.hmccosmetics.util.packets.PacketManager;
 import org.bukkit.Bukkit;
 import org.bukkit.Location;
@@ -10,6 +11,8 @@ import org.bukkit.entity.Player;
 import org.jetbrains.annotations.NotNull;
 import org.spongepowered.configurate.ConfigurationNode;
 
+import java.util.logging.Level;
+
 public class CosmeticBackpackType extends Cosmetic {
 
     private final String modelName;
@@ -30,6 +33,11 @@ public class CosmeticBackpackType extends Cosmetic {
         Location loc = player.getLocation().clone().add(0, 2, 0);
 
         if (user.isInWardrobe() || !user.isBackpackSpawned()) return;
+        if (!user.getUserBackpackManager().getArmorStand().isValid()) {
+            MessagesUtil.sendDebugMessages("Invalid Backpack detected! Respawning backpack, report this on the discord if this happens often!", Level.WARNING);
+            user.respawnBackpack();
+            return;
+        }
         if (loc.getWorld() != user.getUserBackpackManager().getArmorStand().getWorld()) {
             user.getUserBackpackManager().getArmorStand().teleport(loc);
         }

common/src/main/java/com/hibiscusmc/hmccosmetics/listener/PlayerConnectionListener.java

@@ -5,6 +5,7 @@ import com.hibiscusmc.hmccosmetics.config.DatabaseSettings;
 import com.hibiscusmc.hmccosmetics.database.Database;
 import com.hibiscusmc.hmccosmetics.user.CosmeticUser;
 import com.hibiscusmc.hmccosmetics.user.CosmeticUsers;
+import com.hibiscusmc.hmccosmetics.user.manager.UserEmoteManager;
 import com.hibiscusmc.hmccosmetics.util.MessagesUtil;
 import org.bukkit.Bukkit;
 import org.bukkit.entity.Entity;
@@ -60,7 +61,7 @@ public class PlayerConnectionListener implements Listener {
         }
         if (user.isInWardrobe()) user.leaveWardrobe();
         if (user.getUserEmoteManager().isPlayingEmote()) {
-            user.getUserEmoteManager().stopEmote();
+            user.getUserEmoteManager().stopEmote(UserEmoteManager.StopEmoteReason.CONNECTION);
             event.getPlayer().setInvisible(false);
         }
         Database.save(user);

common/src/main/java/com/hibiscusmc/hmccosmetics/listener/PlayerGameListener.java

@@ -20,6 +20,7 @@ import com.hibiscusmc.hmccosmetics.gui.Menu;
 import com.hibiscusmc.hmccosmetics.gui.Menus;
 import com.hibiscusmc.hmccosmetics.user.CosmeticUser;
 import com.hibiscusmc.hmccosmetics.user.CosmeticUsers;
+import com.hibiscusmc.hmccosmetics.user.manager.UserEmoteManager;
 import com.hibiscusmc.hmccosmetics.util.InventoryUtils;
 import com.hibiscusmc.hmccosmetics.util.MessagesUtil;
 import org.bukkit.Bukkit;
@@ -83,7 +84,7 @@ public class PlayerGameListener implements Listener {
 
         if (user == null) return;
         if (event.isSneaking()) {
-            user.getUserEmoteManager().stopEmote();
+            user.getUserEmoteManager().stopEmote(UserEmoteManager.StopEmoteReason.SNEAK);
         }
 
         if (!event.isSneaking()) return;
@@ -153,6 +154,26 @@ public class PlayerGameListener implements Listener {
         event.setCancelled(true);
     }
 
+    @EventHandler
+    public void onPlayerDamaged(EntityDamageEvent event) {
+        if (event.isCancelled()) return;
+        if (!(event.getEntity() instanceof Player)) return;
+        Player player = ((Player) event.getEntity()).getPlayer();
+        CosmeticUser user = CosmeticUsers.getUser(player);
+        if (user == null) return;
+        if (user.getUserEmoteManager().isPlayingEmote()) {
+            if (Settings.isEmoteInvincible()) {
+                event.setCancelled(true);
+            }
+            if (Settings.isEmoteDamageLeave()) {
+                user.getUserEmoteManager().stopEmote(UserEmoteManager.StopEmoteReason.DAMAGE);
+            }
+        }
+        if (user.isInWardrobe()) {
+            user.leaveWardrobe();
+        }
+    }
+
     @EventHandler
     public void onPlayerLook(PlayerMoveEvent event) {
         if (event.isCancelled()) return;

common/src/main/java/com/hibiscusmc/hmccosmetics/user/manager/UserEmoteManager.java

@@ -1,8 +1,12 @@
 package com.hibiscusmc.hmccosmetics.user.manager;
 
+import com.hibiscusmc.hmccosmetics.api.PlayerCosmeticRemoveEvent;
+import com.hibiscusmc.hmccosmetics.api.PlayerEmoteStartEvent;
+import com.hibiscusmc.hmccosmetics.api.PlayerEmoteStopEvent;
 import com.hibiscusmc.hmccosmetics.cosmetic.types.CosmeticEmoteType;
 import com.hibiscusmc.hmccosmetics.user.CosmeticUser;
 import com.hibiscusmc.hmccosmetics.util.MessagesUtil;
+import org.bukkit.Bukkit;
 import org.jetbrains.annotations.NotNull;
 
 public class UserEmoteManager {
@@ -22,6 +26,13 @@ public class UserEmoteManager {
     public void playEmote(String animationId) {
         if (isPlayingEmote()) return;
         if (user.isInWardrobe()) return;
+        // API
+        PlayerEmoteStartEvent event = new PlayerEmoteStartEvent(user, animationId);
+        Bukkit.getPluginManager().callEvent(event);
+        if (event.isCancelled()) {
+            return;
+        }
+        // Internal
         try {
             model = new UserEmoteModel(user);
             model.playAnimation(animationId);
@@ -35,8 +46,21 @@ public class UserEmoteManager {
         return model.isPlayingAnimation();
     }
 
-    public void stopEmote() {
+    public void stopEmote(StopEmoteReason emoteReason) {
         if (!isPlayingEmote()) return;
+        // API
+        PlayerEmoteStopEvent event = new PlayerEmoteStopEvent(user, emoteReason);
+        Bukkit.getPluginManager().callEvent(event);
+        if (event.isCancelled()) {
+            return;
+        }
+        // Internal
         model.stopAnimation();
     }
+
+    public enum StopEmoteReason {
+        SNEAK,
+        DAMAGE,
+        CONNECTION
+    }
 }

common/src/main/resources/config.yml

@@ -24,7 +24,14 @@ cosmetic-settings:
   force-permission-join: true # Checks a player permission if they can have a cosmetic when they join the server.
 
   emote-distance: -3 # This shows how far away the camera should be while a player is doing an emote. Negative is behind player.
-  emote-block-check: true # If the server should check if the block is open (prevents players viewing through blocks)
+  emote-block-check: true # If the server should check if the block is open where the camera is placed (prevents players viewing through blocks)
+  emote-damage-leave: true # If the player should leave the emote when they take damage
+  emote-invincible: false # If the player should not take damage while doing an emote
+
+  helmet-add-enchantments: false # If the plugin should keep enchants on helmets. This is useful as some enchantments are client side only.
+  chest-add-enchantments: false # If the plugin should keep enchants on chestplate. This is useful as some enchantments are client side only.
+  leggings-add-enchantments: false # If the plugin should keep enchants on leggings. This is useful as some enchantments are client side only.
+  boots-add-enchantments: false # If the plugin should keep enchants on boots. This is useful as some enchantments are client side only.
 
   # view distance in blocks that other players will see the backpack cosmetic
   # setting this to lower than the server player view distance should fix the