potential feature for per-player hologram names

JitseB · Jul 16, 2020 · 4da537e · 4da537e
1 parent e909f28
commit 4da537e
Show file tree

Hide file tree

Showing 33 changed files with 302 additions and 42 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -18,5 +18,6 @@ install:
   - ls $HOME/.m2/repository/org/spigotmc/spigot/1.13.2-R0.1-SNAPSHOT >> /dev/null 2>&1 || java -jar BuildTools.jar --rev 1.13.2 >> /dev/null 2>&1
   - ls $HOME/.m2/repository/org/spigotmc/spigot/1.14.4-R0.1-SNAPSHOT >> /dev/null 2>&1 || java -jar BuildTools.jar --rev 1.14.4 >> /dev/null 2>&1
   - ls $HOME/.m2/repository/org/spigotmc/spigot/1.15.2-R0.1-SNAPSHOT >> /dev/null 2>&1 || java -jar BuildTools.jar --rev 1.15.2 >> /dev/null 2>&1
+  - ls $HOME/.m2/repository/org/spigotmc/spigot/1.16.1-R0.1-SNAPSHOT >> /dev/null 2>&1 || java -jar BuildTools.jar --rev 1.16.1 >> /dev/null 2>&1
 script:
   - mvn clean install
diff --git a/api/pom.xml b/api/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <artifactId>npclib</artifactId>
         <groupId>net.jitse</groupId>
-        <version>2.9-SNAPSHOT</version>
+        <version>2.10-SNAPSHOT</version>
     </parent>
 
     <artifactId>npclib-api</artifactId>

diff --git a/api/src/main/java/net/jitse/npclib/api/NPC.java b/api/src/main/java/net/jitse/npclib/api/NPC.java
@@ -8,6 +8,7 @@
 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;
@@ -18,6 +19,39 @@
 
 public interface NPC {
 
+    /**
+     *
+     * @param player
+     * @return unique hologram for that user
+     */
+    Hologram getPlayerHologram(Player player);
+
+    /**
+     *
+     * @param uniqueLines The text that the targetPlayer will see
+     * @param targetPlayer The target player
+     * @return object instance
+     * @author Gatt
+     */
+    NPC setPlayerLines(List<String> uniqueLines, Player targetPlayer);
+
+    /**
+     *
+     * @param uniqueLines The text that the targetPlayer will see
+     * @param targetPlayer The target player
+     * @param update whether or not to send the update packets
+     * @return object instance
+     * @author Gatt
+     */
+    NPC setPlayerLines(List<String> uniqueLines, Player targetPlayer, boolean update);
+
+    /**
+     *
+     * @param targetPlayer The target player
+     * @return the lines that the targetPlayer will see, if null; default lines.
+     */
+    List<String> getPlayerLines(Player targetPlayer);
+
     /**
      * Set the NPC's location.
      * Use this method before using {@link NPC#create}.

diff --git a/api/src/main/java/net/jitse/npclib/internal/MinecraftVersion.java b/api/src/main/java/net/jitse/npclib/internal/MinecraftVersion.java
@@ -16,7 +16,8 @@ public enum MinecraftVersion {
     V1_13_R1,
     V1_13_R2,
     V1_14_R1,
-    V1_15_R1;
+    V1_15_R1,
+    V1_16_R1;
 
     public boolean isAboveOrEqual(MinecraftVersion compare) {
         return ordinal() >= compare.ordinal();

diff --git a/api/src/main/java/net/jitse/npclib/internal/NPCBase.java b/api/src/main/java/net/jitse/npclib/internal/NPCBase.java
@@ -49,6 +49,10 @@ 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<>();
+
     public NPCBase(NPCLib instance, List<String> text) {
         this.instance = instance;
         this.text = text == null ? Collections.emptyList() : text;
@@ -60,6 +64,42 @@ public NPCLib getInstance() {
         return instance;
     }
 
+    @Override
+    public Hologram getPlayerHologram(Player player){
+        Hologram playerHologram = textDisplayHolograms.getOrDefault(player.getUniqueId(), null);
+        return playerHologram;
+    }
+
+    @Override
+    public NPC setPlayerLines(List<String> uniqueLines, Player targetPlayer) {
+        uniqueText.put(targetPlayer.getUniqueId(), uniqueLines);
+        return this;
+    }
+
+    @Override
+    public NPC setPlayerLines(List<String> uniqueLines, Player targetPlayer, boolean update) {
+        List<String> originalLines = getPlayerLines(targetPlayer);
+        setPlayerLines(uniqueLines, targetPlayer);
+        if (update){
+            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
+            }
+
+            Hologram hologram = getPlayerHologram(targetPlayer); //
+            List<Object> updatePackets = hologram.getUpdatePackets(getPlayerLines(targetPlayer));
+            hologram.update(targetPlayer, updatePackets);
+            hologram.show(targetPlayer);
+        }
+        return this;
+    }
+
+    @Override
+    public List<String> getPlayerLines(Player targetPlayer) {
+        return uniqueText.getOrDefault(targetPlayer.getUniqueId(), text);
+    }
+
     @Override
     public UUID getUniqueId() {
         return uuid;
@@ -303,11 +343,16 @@ public NPC setItem(NPCSlot slot, ItemStack item) {
 
     @Override
     public NPC setText(List<String> text) {
-        List<Object> updatePackets = hologram.getUpdatePackets(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);
             }
         }

diff --git a/api/src/main/java/net/jitse/npclib/internal/NPCPacketHandler.java b/api/src/main/java/net/jitse/npclib/internal/NPCPacketHandler.java
@@ -15,6 +15,8 @@ interface NPCPacketHandler {
 
     void createPackets();
 
+    void createPackets(Player player);
+
     void sendShowPackets(Player player);
 
     void sendHidePackets(Player player);

diff --git a/nms/pom.xml b/nms/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>net.jitse</groupId>
         <artifactId>npclib</artifactId>
-        <version>2.9-SNAPSHOT</version>
+        <version>2.10-SNAPSHOT</version>
     </parent>
 
     <artifactId>npclib-nms</artifactId>

diff --git a/nms/v1_10_R1/pom.xml b/nms/v1_10_R1/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>net.jitse</groupId>
         <artifactId>npclib-nms</artifactId>
-        <version>2.9-SNAPSHOT</version>
+        <version>2.10-SNAPSHOT</version>
     </parent>
 
     <artifactId>npclib-nms-v1_10_R1</artifactId>

diff --git a/nms/v1_10_R1/src/main/java/net/jitse/npclib/nms/v1_10_R1/NPC_v1_10_R1.java b/nms/v1_10_R1/src/main/java/net/jitse/npclib/nms/v1_10_R1/NPC_v1_10_R1.java
@@ -38,9 +38,24 @@ public NPC_v1_10_R1(NPCLib instance, List<String> lines) {
         super(instance, lines);
     }
 
+    @Override
+    public Hologram getPlayerHologram(Player player) {
+        Hologram holo = super.getPlayerHologram(player);
+        if (holo == null){
+            holo = new Hologram(MinecraftVersion.V1_10_R1, location.clone().add(0, 0.5, 0), getPlayerLines(player));
+        }
+        super.textDisplayHolograms.put(player.getUniqueId(), holo);
+        return holo;
+    }
+
+
     @Override
     public void createPackets() {
-        this.hologram = new Hologram(MinecraftVersion.V1_10_R1, location.clone().subtract(0, 0.5, 0), text);
+        Bukkit.getOnlinePlayers().forEach(this::createPackets);
+    }
+
+    @Override
+    public void createPackets(Player player) {
 
         PacketPlayOutPlayerInfoWrapper packetPlayOutPlayerInfoWrapper = new PacketPlayOutPlayerInfoWrapper();
 
@@ -74,7 +89,7 @@ public void sendShowPackets(Player player) {
         playerConnection.sendPacket(packetPlayOutNamedEntitySpawn);
         playerConnection.sendPacket(packetPlayOutEntityHeadRotation);
 
-        hologram.show(player);
+        getPlayerHologram(player).show(player);
 
         // Removing the player info after 10 seconds.
         Bukkit.getScheduler().runTaskLater(instance.getPlugin(), () ->

diff --git a/nms/v1_11_R1/pom.xml b/nms/v1_11_R1/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>net.jitse</groupId>
         <artifactId>npclib-nms</artifactId>
-        <version>2.9-SNAPSHOT</version>
+        <version>2.10-SNAPSHOT</version>
     </parent>
 
     <artifactId>npclib-nms-v1_11_R1</artifactId>

diff --git a/nms/v1_11_R1/src/main/java/net/jitse/npclib/nms/v1_11_R1/NPC_v1_11_R1.java b/nms/v1_11_R1/src/main/java/net/jitse/npclib/nms/v1_11_R1/NPC_v1_11_R1.java
@@ -38,9 +38,24 @@ public NPC_v1_11_R1(NPCLib instance, List<String> lines) {
         super(instance, lines);
     }
 
+    @Override
+    public Hologram getPlayerHologram(Player player) {
+        Hologram holo = super.getPlayerHologram(player);
+        if (holo == null){
+            holo = new Hologram(MinecraftVersion.V1_11_R1, location.clone().add(0, 0.5, 0), getPlayerLines(player));
+        }
+        super.textDisplayHolograms.put(player.getUniqueId(), holo);
+        return holo;
+    }
+
+
     @Override
     public void createPackets() {
-        this.hologram = new Hologram(MinecraftVersion.V1_11_R1, location.clone().add(0, 0.5, 0), text);
+        Bukkit.getOnlinePlayers().forEach(this::createPackets);
+    }
+
+    @Override
+    public void createPackets(Player player) {
 
         PacketPlayOutPlayerInfoWrapper packetPlayOutPlayerInfoWrapper = new PacketPlayOutPlayerInfoWrapper();
 
@@ -74,7 +89,7 @@ public void sendShowPackets(Player player) {
         playerConnection.sendPacket(packetPlayOutNamedEntitySpawn);
         playerConnection.sendPacket(packetPlayOutEntityHeadRotation);
 
-        hologram.show(player);
+        getPlayerHologram(player).show(player);
 
         // Removing the player info after 10 seconds.
         Bukkit.getScheduler().runTaskLater(instance.getPlugin(), () ->

diff --git a/nms/v1_12_R1/pom.xml b/nms/v1_12_R1/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>net.jitse</groupId>
         <artifactId>npclib-nms</artifactId>
-        <version>2.9-SNAPSHOT</version>
+        <version>2.10-SNAPSHOT</version>
     </parent>
 
     <artifactId>npclib-nms-v1_12_R1</artifactId>

diff --git a/nms/v1_12_R1/src/main/java/net/jitse/npclib/nms/v1_12_R1/NPC_v1_12_R1.java b/nms/v1_12_R1/src/main/java/net/jitse/npclib/nms/v1_12_R1/NPC_v1_12_R1.java
@@ -38,9 +38,24 @@ public NPC_v1_12_R1(NPCLib instance, List<String> lines) {
         super(instance, lines);
     }
 
+    @Override
+    public Hologram getPlayerHologram(Player player) {
+        Hologram holo = super.getPlayerHologram(player);
+        if (holo == null){
+            holo = new Hologram(MinecraftVersion.V1_12_R1, location.clone().add(0, 0.5, 0), getPlayerLines(player));
+        }
+        super.textDisplayHolograms.put(player.getUniqueId(), holo);
+        return holo;
+    }
+
+
     @Override
     public void createPackets() {
-        this.hologram = new Hologram(MinecraftVersion.V1_12_R1, location.clone().add(0, 0.5, 0), text);
+        Bukkit.getOnlinePlayers().forEach(this::createPackets);
+    }
+
+    @Override
+    public void createPackets(Player player) {
 
         PacketPlayOutPlayerInfoWrapper packetPlayOutPlayerInfoWrapper = new PacketPlayOutPlayerInfoWrapper();
 
@@ -74,7 +89,7 @@ public void sendShowPackets(Player player) {
         playerConnection.sendPacket(packetPlayOutNamedEntitySpawn);
         playerConnection.sendPacket(packetPlayOutEntityHeadRotation);
 
-        hologram.show(player);
+        getPlayerHologram(player).show(player);
 
         // Removing the player info after 10 seconds.
         Bukkit.getScheduler().runTaskLater(instance.getPlugin(), () ->

diff --git a/nms/v1_13_R1/pom.xml b/nms/v1_13_R1/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>net.jitse</groupId>
         <artifactId>npclib-nms</artifactId>
-        <version>2.9-SNAPSHOT</version>
+        <version>2.10-SNAPSHOT</version>
     </parent>
 
     <artifactId>npclib-nms-v1_13_R1</artifactId>

diff --git a/nms/v1_13_R1/src/main/java/net/jitse/npclib/nms/v1_13_R1/NPC_v1_13_R1.java b/nms/v1_13_R1/src/main/java/net/jitse/npclib/nms/v1_13_R1/NPC_v1_13_R1.java
@@ -38,9 +38,24 @@ public NPC_v1_13_R1(NPCLib instance, List<String> lines) {
         super(instance, lines);
     }
 
+    @Override
+    public Hologram getPlayerHologram(Player player) {
+        Hologram holo = super.getPlayerHologram(player);
+        if (holo == null){
+            holo = new Hologram(MinecraftVersion.V1_13_R1, location.clone().add(0, 0.5, 0), getPlayerLines(player));
+        }
+        super.textDisplayHolograms.put(player.getUniqueId(), holo);
+        return holo;
+    }
+
+
     @Override
     public void createPackets() {
-        this.hologram = new Hologram(MinecraftVersion.V1_13_R1, location.clone().add(0, 0.5, 0), text);
+        Bukkit.getOnlinePlayers().forEach(this::createPackets);
+    }
+
+    @Override
+    public void createPackets(Player player) {
 
         PacketPlayOutPlayerInfoWrapper packetPlayOutPlayerInfoWrapper = new PacketPlayOutPlayerInfoWrapper();
 
@@ -74,7 +89,7 @@ public void sendShowPackets(Player player) {
         playerConnection.sendPacket(packetPlayOutNamedEntitySpawn);
         playerConnection.sendPacket(packetPlayOutEntityHeadRotation);
 
-        hologram.show(player);
+        getPlayerHologram(player).show(player);
 
         // Removing the player info after 10 seconds.
         Bukkit.getScheduler().runTaskLater(instance.getPlugin(), () ->

diff --git a/nms/v1_13_R2/pom.xml b/nms/v1_13_R2/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>net.jitse</groupId>
         <artifactId>npclib-nms</artifactId>
-        <version>2.9-SNAPSHOT</version>
+        <version>2.10-SNAPSHOT</version>
     </parent>
 
     <artifactId>npclib-nms-v1_13_R2</artifactId>

diff --git a/nms/v1_13_R2/src/main/java/net/jitse/npclib/nms/v1_13_R2/NPC_v1_13_R2.java b/nms/v1_13_R2/src/main/java/net/jitse/npclib/nms/v1_13_R2/NPC_v1_13_R2.java
@@ -37,10 +37,24 @@ public class NPC_v1_13_R2 extends NPCBase {
     public NPC_v1_13_R2(NPCLib instance, List<String> lines) {
         super(instance, lines);
     }
+    @Override
+    public Hologram getPlayerHologram(Player player) {
+        Hologram holo = super.getPlayerHologram(player);
+        if (holo == null){
+            holo = new Hologram(MinecraftVersion.V1_13_R2, location.clone().add(0, 0.5, 0), getPlayerLines(player));
+        }
+        super.textDisplayHolograms.put(player.getUniqueId(), holo);
+        return holo;
+    }
+
 
     @Override
     public void createPackets() {
-        this.hologram = new Hologram(MinecraftVersion.V1_13_R2, location.clone().add(0, 0.5, 0), text);
+        Bukkit.getOnlinePlayers().forEach(this::createPackets);
+    }
+
+    @Override
+    public void createPackets(Player player) {
 
         PacketPlayOutPlayerInfoWrapper packetPlayOutPlayerInfoWrapper = new PacketPlayOutPlayerInfoWrapper();
 
@@ -74,7 +88,7 @@ public void sendShowPackets(Player player) {
         playerConnection.sendPacket(packetPlayOutNamedEntitySpawn);
         playerConnection.sendPacket(packetPlayOutEntityHeadRotation);
 
-        hologram.show(player);
+        getPlayerHologram(player).show(player);
 
         // Removing the player info after 10 seconds.
         Bukkit.getScheduler().runTaskLater(instance.getPlugin(), () ->

diff --git a/nms/v1_14_R1/pom.xml b/nms/v1_14_R1/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>net.jitse</groupId>
         <artifactId>npclib-nms</artifactId>
-        <version>2.9-SNAPSHOT</version>
+        <version>2.10-SNAPSHOT</version>
     </parent>
 
     <artifactId>npclib-nms-v1_14_R1</artifactId>