pre-release for 2.12

Author: Jitse Boonstra

README.md

@@ -7,9 +7,6 @@ NPCLib – Basic non-player character library.<br>
 [![Discord](https://img.shields.io/badge/Support-Discord-blue.svg)](https://discord.gg/pvJGhEq)
 =
 
-`This project is starting 5 Oct. 2020 no longer actively maintained. I Thank you all for riding along!`
-
-
 This is an API made specifically for spigot servers (Minecraft). Current supported versions: **1.8.8 - latest**. Lightweight replacement for Citizens. NPCLib only uses packets instead of registering the entity in the actual Minecraft server.
 
 ### Preview (click to play video)

api/pom.xml

@@ -8,7 +8,7 @@
     <parent>
         <artifactId>npclib</artifactId>
         <groupId>net.jitse</groupId>
-        <version>2.11.1-SNAPSHOT</version>
+        <version>2.12-SNAPSHOT</version>
     </parent>
 
     <artifactId>npclib-api</artifactId>

api/src/main/java/com/comphenix/tinyprotocol/TinyProtocol.java

@@ -25,7 +25,7 @@
 import java.util.concurrent.atomic.AtomicInteger;
 
 /**
- * Minimized version of TinyProtocol by Kristian suited for NPCLib.
+ * Minimized version of TinyProtocol by Kristian suited for NPCLib, modifications and refactoring by Jitse.
  */
 public abstract class TinyProtocol {
     private static final AtomicInteger ID = new AtomicInteger(0);
@@ -50,7 +50,8 @@ public abstract class TinyProtocol {
     private static final Reflection.FieldAccessor<GameProfile> getGameProfile = Reflection.getField(PACKET_LOGIN_IN_START, GameProfile.class, 0);
 
     // Speedup channel lookup
-    private Map<String, Channel> channelLookup = new MapMaker().weakValues().makeMap();
+    // Made channelLookup UUID-based (JMB - 23rd Jan. 2021)
+    private Map<UUID, Channel> channelLookup = new MapMaker().weakValues().makeMap();
     private Listener listener;
 
     // Channels that have already been removed
@@ -89,6 +90,7 @@ protected TinyProtocol(NPCLib instance) {
             registerChannelHandler();
             registerPlayers(plugin);
             injected = true;
+            instance.getLogger().info("Injection complete");
         } catch (IllegalArgumentException ex) {
             // Damn you, late bind
             instance.getLogger().warning("Attempting to delay injection");
@@ -271,14 +273,14 @@ private PacketInterceptor injectChannelInternal(Channel channel) {
     }
 
     private Channel getChannel(Player player) {
-        Channel channel = channelLookup.get(player.getName());
+        Channel channel = channelLookup.get(player.getUniqueId());
 
         // Lookup channel again
         if (channel == null) {
             Object connection = getConnection.get(getPlayerHandle.invoke(player));
             Object manager = getManager.get(connection);
 
-            channelLookup.put(player.getName(), channel = getChannel.get(manager));
+            channelLookup.put(player.getUniqueId(), channel = getChannel.get(manager));
         }
 
         return channel;
@@ -292,9 +294,7 @@ private void close() {
             for (Player player : plugin.getServer().getOnlinePlayers()) {
                 // No need to guard against this if we're closing
                 Channel channel = getChannel(player);
-                if (!closed) {
-                    uninjectedChannels.add(channel);
-                }
+                if (!closed) uninjectedChannels.add(channel);
 
                 // See ChannelInjector in ProtocolLib, line 590
                 channel.eventLoop().execute(() -> channel.pipeline().remove(handlerName));
@@ -324,12 +324,10 @@ public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception
             try {
                 msg = onPacketInAsync(player, msg);
             } catch (Exception e) {
-                instance.getLogger().severe("Error in onPacketInAsync().", e);
+                instance.getLogger().severe("Error in onPacketInAsync()", e);
             }
 
-            if (msg != null) {
-                super.channelRead(ctx, msg);
-            }
+            if (msg != null) super.channelRead(ctx, msg);
         }
 
         // Keeping this here for testing purposes:
@@ -338,7 +336,7 @@ public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception
 //            try {
 //                msg = onPacketOutAsync(player, ctx.channel(), msg);
 //            } catch (Exception e) {
-//                instance.getLogger().severe("Error in onPacketOutAsync().", e);
+//                instance.getLogger().severe("Error in onPacketOutAsync()", e);
 //            }
 //
 //            if (msg != null) {
@@ -349,7 +347,7 @@ public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception
         private void handleLoginStart(Channel channel, Object packet) {
             if (PACKET_LOGIN_IN_START.isInstance(packet)) {
                 GameProfile profile = getGameProfile.get(packet);
-                channelLookup.put(profile.getName(), channel);
+                channelLookup.put(profile.getId(), channel);
             }
         }
     }

api/src/main/java/net/jitse/npclib/api/NPC.java

@@ -8,7 +8,6 @@
 import net.jitse.npclib.api.state.NPCAnimation;
 import net.jitse.npclib.api.state.NPCSlot;
 import net.jitse.npclib.api.state.NPCState;
-import net.jitse.npclib.hologram.Hologram;
 import org.bukkit.Location;
 import org.bukkit.World;
 import org.bukkit.entity.Player;
@@ -20,51 +19,29 @@
 public interface NPC {
 
     /**
-     * @param player
-     * @return unique hologram for that user
-     */
-    Hologram getPlayerHologram(Player player);
-
-    /**
-     *
-     * @param targetPlayer The target player
-     * @return object instance
-     * @author Gatt
-     */
-    NPC removePlayerLines(Player targetPlayer);
-    /**
-     *
-     * @param targetPlayer The target player
-     * @param update whether or not to update the hologram
+     * @param player The target player
      * @return object instance
-     * @author Gatt
      */
-    NPC removePlayerLines(Player targetPlayer, boolean update);
+    NPC removeText(Player player);
 
     /**
-     *
-     * @param uniqueLines The text that the targetPlayer will see. Null to remove
-     * @param targetPlayer The target player
+     * @param text   The text that the player will see. Null to remove
+     * @param player The target player
      * @return object instance
-     * @author Gatt
      */
-    NPC setPlayerLines(List<String> uniqueLines, Player targetPlayer);
+    NPC setText(Player player, List<String> text);
 
     /**
-     * @param uniqueLines  The text that the targetPlayer will see
-     * @param targetPlayer The target player
-     * @param update       whether or not to send the update packets
+     * @param text The text that all players will see. Null to remove
      * @return object instance
-     * @author Gatt
      */
-    NPC setPlayerLines(List<String> uniqueLines, Player targetPlayer, boolean update);
+    NPC setText(List<String> text);
 
     /**
-     * @param targetPlayer The target player
-     * @return the lines that the targetPlayer will see, if null; default lines.
-     * @author Gatt
+     * @param player The target player
+     * @return the lines that the player will see, if null; default lines.
      */
-    List<String> getPlayerLines(Player targetPlayer);
+    List<String> getText(Player player);
 
     /**
      * Set the NPC's location.
@@ -183,8 +160,6 @@ public interface NPC {
      */
     NPC setItem(NPCSlot slot, ItemStack item);
 
-    NPC setText(List<String> text);
-
     /**
      * Get the text of an NPC
      *

api/src/main/java/net/jitse/npclib/internal/NPCBase.java

@@ -53,12 +53,12 @@ public abstract class NPCBase implements NPC, NPCPacketHandler {
     protected final Map<NPCSlot, ItemStack> items = new EnumMap<>(NPCSlot.class);
 
     // Storage for per-player text;
-    protected final Map<UUID, List<String>> uniqueText = new HashMap<>();
-    protected final Map<UUID, Hologram> textDisplayHolograms = new HashMap<>();
+    protected final Map<UUID, List<String>> playerText = new HashMap<>();
+    protected final Map<UUID, Hologram> playerHologram = new HashMap<>();
 
     public NPCBase(NPCLib instance, List<String> text) {
         this.instance = instance;
-        this.text = text == null ? Collections.emptyList() : text;
+        this.text = text != null ? text : Collections.emptyList();
 
         NPCManager.add(this);
     }
@@ -67,64 +67,59 @@ public NPCLib getInstance() {
         return instance;
     }
 
-    @Override
-    public Hologram getPlayerHologram(Player player) {
+    // Unique per-player hologram by Gatt, modifications and refactoring done by Jitse (JMB - 23rd Jan. 2021).
+    protected Hologram getHologram(Player player) {
         Validate.notNull(player, "Player cannot be null.");
-        Hologram playerHologram = textDisplayHolograms.getOrDefault(player.getUniqueId(), null);
-        return playerHologram;
+        return playerHologram.getOrDefault(player.getUniqueId(), null); // If null, NMS version will return new hologram instance.
     }
 
-
     @Override
-    public NPC removePlayerLines(Player targetPlayer) {
-        Validate.notNull(targetPlayer, "Player cannot be null.");
-        setPlayerLines(null, targetPlayer);
+    public NPC removeText(Player player) {
+        Validate.notNull(player, "Player cannot be null.");
+        setText(player, null);
         return this;
     }
 
     @Override
-    public NPC removePlayerLines(Player targetPlayer, boolean update) {
-        Validate.notNull(targetPlayer, "Player cannot be null.");
-        setPlayerLines(null, targetPlayer, update);
-        return this;
-    }
+    public NPC setText(Player player, List<String> text) {
+        Validate.notNull(player, "Player cannot be null.");
+        List<String> originalText = getText(player);
 
-    @Override
-    public NPC setPlayerLines(List<String> uniqueLines, Player targetPlayer) {
-        Validate.notNull(targetPlayer, "Player cannot be null.");
-        if (uniqueLines == null) uniqueText.remove(targetPlayer.getUniqueId());
-        else uniqueText.put(targetPlayer.getUniqueId(), uniqueLines);
+        if (text == null) {
+            playerText.remove(player.getUniqueId());
+        } else playerText.put(player.getUniqueId(), text);
+
+        if (originalText.size() != text.size()) { // recreate the entire hologram
+            Hologram originalHologram = getHologram(player);
+            originalHologram.hide(player); // essentially destroy the hologram
+            playerHologram.remove(player.getUniqueId()); // remove the old object
+        }
+        if (isShown(player)) { // only show hologram if the player is in range
+            if (originalText.size() != text.size()) {
+                getHologram(player).show(player);
+            } else {
+                Hologram hologram = getHologram(player);
+                List<Object> updatePackets = hologram.getUpdatePackets(text);
+                hologram.update(player, updatePackets);
+            }
+        }
         return this;
     }
 
     @Override
-    public NPC setPlayerLines(List<String> uniqueLines, Player targetPlayer, boolean update) {
-        Validate.notNull(targetPlayer, "Player cannot be null.");
-        List<String> originalLines = getPlayerLines(targetPlayer);
-        setPlayerLines(uniqueLines, targetPlayer);
-        if (update) {
-
-            uniqueLines = getPlayerLines(targetPlayer); // retrieve the player lines from this function, incase it's been removed.
-
-            if (originalLines.size() != uniqueLines.size()) { // recreate the entire hologram
-                Hologram originalhologram = getPlayerHologram(targetPlayer);
-                originalhologram.hide(targetPlayer); // essentially destroy the hologram
-                textDisplayHolograms.remove(targetPlayer.getUniqueId()); // remove the old obj
-            }
-
-            if (isShown(targetPlayer)) { //only show hologram if the player is in range
-                Hologram hologram = getPlayerHologram(targetPlayer);
-                List<Object> updatePackets = hologram.getUpdatePackets(getPlayerLines(targetPlayer));
-                hologram.update(targetPlayer, updatePackets);
-            }
+    public NPC setText(List<String> text) {
+        for (UUID uuid : shown) {
+            Player player = Bukkit.getPlayer(uuid);
+            if (player == null) continue;
+            setText(player, text);
         }
         return this;
     }
 
     @Override
-    public List<String> getPlayerLines(Player targetPlayer) {
-        Validate.notNull(targetPlayer, "Player cannot be null.");
-        return uniqueText.getOrDefault(targetPlayer.getUniqueId(), text);
+    public List<String> getText(Player player) {
+        Validate.notNull(player, "Player cannot be null.");
+        return playerText.getOrDefault(player.getUniqueId(), text);
     }
 
     @Override
@@ -154,14 +149,9 @@ public void destroy() {
 
         // Destroy NPC for every player that is still seeing it.
         for (UUID uuid : shown) {
-            if (autoHidden.contains(uuid)) {
-                continue;
-            }
-            Player plyr = Bukkit.getPlayer(uuid); // destroy the per player holograms
-            if (plyr != null) {
-                getPlayerHologram(plyr).hide(plyr);
-                hide(plyr, true);
-            }
+            if (autoHidden.contains(uuid)) continue;
+            Player player = Bukkit.getPlayer(uuid);
+            if (player != null) hide(player, true); // which will also destroy the holograms
         }
     }
 
@@ -379,33 +369,13 @@ public NPC setItem(NPCSlot slot, ItemStack item) {
         return this;
     }
 
-    @Override
-    public NPC setText(List<String> text) {
-        uniqueText.clear();
-
-        for (UUID shownUuid : shown) {
-            Player player = Bukkit.getPlayer(shownUuid);
-            if (player != null && isShown(player)) {
-                Hologram originalHologram = getPlayerHologram(player);
-                originalHologram.hide(player); // essentially destroy the hologram
-                textDisplayHolograms.remove(player.getUniqueId()); // remove the old obj
-                Hologram hologram = getPlayerHologram(player); // let it regenerate
-                List<Object> updatePackets = hologram.getUpdatePackets(getPlayerLines(player));
-                hologram.update(player, updatePackets);
-            }
-        }
-
-        this.text = text;
-        return this;
-    }
-
     @Override
     public List<String> getText() {
         return text;
     }
-    
+
     @Override
     public void lookAt(Location location) {
-    	sendHeadRotationPackets(location);
+        sendHeadRotationPackets(location);
     }
 }

nms/pom.xml

@@ -8,23 +8,23 @@
     <parent>
         <groupId>net.jitse</groupId>
         <artifactId>npclib</artifactId>
-        <version>2.11.1-SNAPSHOT</version>
+        <version>2.12-SNAPSHOT</version>
     </parent>
 
     <artifactId>npclib-nms</artifactId>
 
     <modules>
-        <module>v1_8_R3</module>
-        <module>v1_9_R1</module>
-        <module>v1_9_R2</module>
-        <module>v1_10_R1</module>
-        <module>v1_11_R1</module>
-        <module>v1_12_R1</module>
-        <module>v1_13_R1</module>
-        <module>v1_13_R2</module>
-        <module>v1_14_R1</module>
-        <module>v1_15_R1</module>
-        <module>v1_16_R1</module>
+        <!--        <module>v1_8_R3</module>-->
+        <!--        <module>v1_9_R1</module>-->
+        <!--        <module>v1_9_R2</module>-->
+        <!--        <module>v1_10_R1</module>-->
+        <!--        <module>v1_11_R1</module>-->
+        <!--        <module>v1_12_R1</module>-->
+        <!--        <module>v1_13_R1</module>-->
+        <!--        <module>v1_13_R2</module>-->
+        <!--        <module>v1_14_R1</module>-->
+        <!--        <module>v1_15_R1</module>-->
+        <!--        <module>v1_16_R1</module>-->
         <module>v1_16_R2</module>
         <module>v1_16_R3</module>
     </modules>