NPC Trait Updates

paper/pom.xml

@@ -31,7 +31,7 @@
         <dependency>
             <groupId>net.citizensnpcs</groupId>
             <artifactId>citizens-main</artifactId>
-            <version>2.0.42-SNAPSHOT</version>
+            <version>2.0.43-SNAPSHOT</version>
             <type>jar</type>
             <scope>provided</scope>
             <exclusions>

paper/src/main/java/com/denizenscript/denizen/paper/properties/EntitySneaking.java

@@ -1,11 +1,11 @@
 package com.denizenscript.denizen.paper.properties;
 
-import com.denizenscript.denizen.npc.traits.SneakingTrait;
 import com.denizenscript.denizen.objects.EntityTag;
 import com.denizenscript.denizen.objects.properties.entity.EntityProperty;
 import com.denizenscript.denizencore.objects.Mechanism;
 import com.denizenscript.denizencore.objects.core.ElementTag;
 import net.citizensnpcs.api.npc.NPC;
+import net.citizensnpcs.trait.SneakTrait;
 
 public class EntitySneaking extends EntityProperty<ElementTag> {
 
@@ -36,19 +36,20 @@ public boolean isDefaultValue(ElementTag value) {
 
     @Override
     public void setPropertyValue(ElementTag value, Mechanism mechanism) {
-        if (mechanism.requireBoolean()) {
-            boolean sneaking = value.asBoolean();
-            getEntity().setSneaking(sneaking);
-            if (object.isCitizensNPC()) {
-                NPC npc = object.getDenizenNPC().getCitizen();
-                if (sneaking) {
-                    npc.getOrAddTrait(SneakingTrait.class).sneak();
-                }
-                else if (npc.hasTrait(SneakingTrait.class)) {
-                    npc.getTraitNullable(SneakingTrait.class).stand();
-                    npc.removeTrait(SneakingTrait.class);
-                }
-            }
+        if (!mechanism.requireBoolean()) {
+            return;
+        }
+        boolean sneaking = value.asBoolean();
+        getEntity().setSneaking(sneaking);
+        if (!object.isCitizensNPC()) {
+            return;
+        }
+        NPC npc = object.getDenizenNPC().getCitizen();
+        if (sneaking) {
+            npc.getOrAddTrait(SneakTrait.class).setSneaking(true);
+        }
+        else if (npc.hasTrait(SneakTrait.class)) {
+            npc.getOrAddTrait(SneakTrait.class).setSneaking(false);
         }
     }
 

plugin/pom.xml

@@ -44,7 +44,7 @@
         <dependency>
             <groupId>net.citizensnpcs</groupId>
             <artifactId>citizens-main</artifactId>
-            <version>2.0.42-SNAPSHOT</version>
+            <version>2.0.43-SNAPSHOT</version>
             <type>jar</type>
             <scope>provided</scope>
             <exclusions>

plugin/src/main/java/com/denizenscript/denizen/npc/DenizenNPCHelper.java

@@ -3,23 +3,28 @@
 import com.denizenscript.denizen.Denizen;
 import com.denizenscript.denizen.events.entity.EntityDespawnScriptEvent;
 import com.denizenscript.denizen.npc.actions.ActionHandler;
+import com.denizenscript.denizen.npc.traits.SittingTrait;
+import com.denizenscript.denizen.npc.traits.SleepingTrait;
+import com.denizenscript.denizen.npc.traits.SneakingTrait;
 import com.denizenscript.denizen.objects.EntityTag;
 import com.denizenscript.denizen.objects.NPCTag;
-import com.denizenscript.denizencore.utilities.debugging.Debug;
 import com.denizenscript.denizen.utilities.depends.Depends;
 import com.denizenscript.denizencore.objects.core.ElementTag;
-import net.citizensnpcs.api.event.NPCDespawnEvent;
-import net.citizensnpcs.api.event.NPCRemoveEvent;
-import net.citizensnpcs.api.event.NPCSpawnEvent;
+import com.denizenscript.denizencore.utilities.debugging.Debug;
+import net.citizensnpcs.api.CitizensAPI;
+import net.citizensnpcs.api.event.*;
 import net.citizensnpcs.api.npc.NPC;
+import net.citizensnpcs.trait.SitTrait;
+import net.citizensnpcs.trait.SleepTrait;
+import net.citizensnpcs.trait.SneakTrait;
 import org.bukkit.Bukkit;
 import org.bukkit.event.EventHandler;
 import org.bukkit.event.Listener;
 import org.bukkit.event.inventory.InventoryType;
 import org.bukkit.inventory.Inventory;
 import org.bukkit.inventory.InventoryHolder;
 
-import java.util.*;
+import java.util.Arrays;
 
 public class DenizenNPCHelper implements Listener {
 
@@ -145,4 +150,29 @@ public void onRemove(NPCRemoveEvent event) {
         NPC npc = event.getNPC();
         new NPCTag(npc).action("remove", null);
     }
+
+    // backwards compat: SittingTrait, SleepingTrait, and SneakingTrait are deprecated versions.
+    @EventHandler
+    public void onCitizensEnable(CitizensEnableEvent event) {
+        for (NPC npc : CitizensAPI.getNPCRegistry()) {
+            if (npc.hasTrait(SittingTrait.class)) {
+                if (npc.getOrAddTrait(SittingTrait.class).isSitting()) {
+                    npc.getOrAddTrait(SitTrait.class).setSitting(npc.getStoredLocation());
+                }
+                npc.removeTrait(SittingTrait.class);
+            }
+            if (!SleepingTrait.isSupported() && npc.hasTrait(SleepingTrait.class)) {
+                if (npc.getOrAddTrait(SleepingTrait.class).isSleeping()) {
+                    npc.getOrAddTrait(SleepTrait.class).setSleeping(npc.getStoredLocation());
+                }
+                npc.removeTrait(SleepingTrait.class);
+            }
+            if (npc.hasTrait(SneakingTrait.class)) {
+                if (npc.getOrAddTrait(SneakingTrait.class).isSneaking()) {
+                    npc.getOrAddTrait(SneakTrait.class).setSneaking(true);
+                }
+                npc.removeTrait(SneakingTrait.class);
+            }
+        }
+    }
 }

plugin/src/main/java/com/denizenscript/denizen/npc/traits/SittingTrait.java

@@ -28,6 +28,7 @@
 import org.bukkit.metadata.FixedMetadataValue;
 import org.bukkit.scheduler.BukkitRunnable;
 
+@Deprecated(forRemoval = true)
 public class SittingTrait extends Trait implements Listener {
 
     @Persist("sitting")

plugin/src/main/java/com/denizenscript/denizen/npc/traits/SleepingTrait.java

@@ -2,22 +2,25 @@
 
 import com.denizenscript.denizen.Denizen;
 import com.denizenscript.denizen.nms.NMSHandler;
+import com.denizenscript.denizen.nms.NMSVersion;
 import com.denizenscript.denizen.utilities.Utilities;
 import com.denizenscript.denizencore.utilities.debugging.Debug;
 import net.citizensnpcs.api.persistence.Persist;
 import net.citizensnpcs.api.trait.Trait;
 import org.bukkit.Bukkit;
 import org.bukkit.Location;
 import org.bukkit.block.data.type.Bed;
-import org.bukkit.entity.LivingEntity;
-import org.bukkit.entity.Player;
-import org.bukkit.entity.Pose;
-import org.bukkit.entity.Villager;
+import org.bukkit.entity.*;
 import org.bukkit.event.EventHandler;
 import org.bukkit.event.block.BlockBreakEvent;
 
+@Deprecated(forRemoval = true)
 public class SleepingTrait extends Trait {
 
+    public static boolean isSupported() {
+        return NMSHandler.getVersion().isAtMost(NMSVersion.v1_20);
+    }
+
     @Persist("sleeping")
     private boolean sleeping = false;
 
@@ -47,14 +50,14 @@ public void onSpawn() {
     }
 
     public void internalSleepNow() {
-        if (npc.getEntity() instanceof Villager) {
-            if (!((Villager) npc.getEntity()).sleep(bedLocation.clone())) {
+        if (npc.getEntity() instanceof Villager villager) {
+            if (!villager.sleep(bedLocation.clone())) {
                 return;
             }
         }
-        else if (npc.getEntity() instanceof Player) {
+        else if (npc.getEntity() instanceof Player player) {
             if (bedLocation.getBlock().getBlockData() instanceof Bed) {
-                ((Player) npc.getEntity()).sleep(bedLocation.clone(), true);
+                player.sleep(bedLocation.clone(), true);
             }
             else {
                 NMSHandler.entityHelper.setPose(npc.getEntity(), Pose.SLEEPING);
@@ -115,8 +118,8 @@ public void wakeUp() {
             return;
         }
         sleeping = false;
-        if (npc.getEntity() instanceof Villager) {
-            ((Villager) npc.getEntity()).wakeup();
+        if (npc.getEntity() instanceof Villager villager) {
+            villager.wakeup();
         }
         else {
             if (((Player) npc.getEntity()).isSleeping()) {
@@ -138,7 +141,7 @@ public boolean isSleeping() {
 
     /**
      * Gets the bed the NPC is sleeping on
-     * Returns null if the NPC isnt sleeping
+     * Returns null if the NPC isn't sleeping
      *
      * @return Location
      */

plugin/src/main/java/com/denizenscript/denizen/npc/traits/SneakingTrait.java

@@ -7,6 +7,7 @@
 import org.bukkit.entity.EntityType;
 import org.bukkit.event.Listener;
 
+@Deprecated(forRemoval = true)
 public class SneakingTrait extends Trait implements Listener {
 
     @Persist("sneaking")

plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java

@@ -479,7 +479,7 @@ public static void register() {
         // -->
         tagProcessor.registerTag(ElementTag.class, "is_sitting", (attribute, object) -> {
             NPC citizen = object.getCitizen();
-            return new ElementTag(citizen.hasTrait(SittingTrait.class) && citizen.getOrAddTrait(SittingTrait.class).isSitting());
+            return new ElementTag(citizen.hasTrait(SitTrait.class) && citizen.getOrAddTrait(SitTrait.class).isSitting());
         });
 
         // <--[tag]
@@ -490,7 +490,8 @@ public static void register() {
         // -->
         tagProcessor.registerTag(ElementTag.class, "is_sleeping", (attribute, object) -> {
             NPC citizen = object.getCitizen();
-            return new ElementTag(citizen.hasTrait(SleepingTrait.class) && citizen.getOrAddTrait(SleepingTrait.class).isSleeping());
+            return new ElementTag((!SleepingTrait.isSupported() && citizen.hasTrait(SleepTrait.class) && citizen.getOrAddTrait(SleepTrait.class).isSleeping())
+                                    || (SleepingTrait.isSupported() && citizen.hasTrait(SleepingTrait.class) && citizen.getOrAddTrait(SleepingTrait.class).isSleeping()));
         });
 
         // <--[tag]
@@ -1769,15 +1770,8 @@ else if (npcEntity instanceof FallingBlock) {
         // <NPCTag.is_sneaking>
         // -->
         tagProcessor.registerMechanism("set_sneaking", false, ElementTag.class, (object, mechanism, input) -> {
-            if (!mechanism.requireBoolean()) {
-                return;
-            }
-            SneakingTrait trait = object.getCitizen().getOrAddTrait(SneakingTrait.class);
-            if (trait.isSneaking() && !input.asBoolean()) {
-                trait.stand();
-            }
-            else if (!trait.isSneaking() && input.asBoolean()) {
-                trait.sneak();
+            if (mechanism.requireBoolean()) {
+                object.getCitizen().getOrAddTrait(SneakTrait.class).setSneaking(input.asBoolean());
             }
         });