Add team scoreboard API

Author: games647

plugin/src/main/java/com/github/games647/scoreboardstats/ScoreboardStats.java

@@ -32,6 +32,8 @@ public class ScoreboardStats extends JavaPlugin {
 
     private static Logger createLoggerFromJDK(java.util.logging.Logger parent) {
         try {
+            parent.setLevel(Level.ALL);
+
             Class<JDK14LoggerAdapter> adapterClass = JDK14LoggerAdapter.class;
             Constructor<JDK14LoggerAdapter> cons = adapterClass.getDeclaredConstructor(java.util.logging.Logger.class);
             cons.setAccessible(true);

plugin/src/main/java/com/github/games647/scoreboardstats/scoreboard/Objective.java

@@ -23,8 +23,10 @@ public class Objective {
 
     private static final int MAX_ITEM_SIZE = 15;
     private static final int SIDEBAR_SLOT = 1;
+
     //A scoreboard can only hold < 16 scores
     final Map<String, Integer> scores = Maps.newHashMapWithExpectedSize(MAX_ITEM_SIZE);
+
     private final PlayerScoreboard scoreboard;
     private final String objectiveId;
     String displayName;

plugin/src/main/java/com/github/games647/scoreboardstats/scoreboard/PacketListener.java

@@ -7,6 +7,7 @@
 import com.comphenix.protocol.events.PacketEvent;
 import com.comphenix.protocol.wrappers.EnumWrappers.ScoreboardAction;
 
+import java.util.Collection;
 import java.util.Optional;
 
 import org.bukkit.Bukkit;
@@ -17,6 +18,7 @@
 import static com.comphenix.protocol.PacketType.Play.Server.SCOREBOARD_DISPLAY_OBJECTIVE;
 import static com.comphenix.protocol.PacketType.Play.Server.SCOREBOARD_OBJECTIVE;
 import static com.comphenix.protocol.PacketType.Play.Server.SCOREBOARD_SCORE;
+import static com.comphenix.protocol.PacketType.Play.Server.SCOREBOARD_TEAM;
 
 /**
  * Listening all outgoing packets and check + handle for possibly client crash cases. This Listener should only read and
@@ -29,7 +31,7 @@ class PacketListener extends PacketAdapter {
     private final PacketManager manager;
 
     PacketListener(Plugin plugin, PacketManager manager) {
-        super(plugin, SCOREBOARD_DISPLAY_OBJECTIVE, SCOREBOARD_OBJECTIVE, SCOREBOARD_SCORE);
+        super(plugin, SCOREBOARD_DISPLAY_OBJECTIVE, SCOREBOARD_OBJECTIVE, SCOREBOARD_SCORE, SCOREBOARD_TEAM);
 
         this.manager = manager;
     }
@@ -58,6 +60,8 @@ public void onPacketSending(PacketEvent packetEvent) {
                 handleObjectivePacket(player, packet);
             } else if (packetType.equals(SCOREBOARD_DISPLAY_OBJECTIVE)) {
                 handleDisplayPacket(player, packet);
+            } else if (packetType.equals(SCOREBOARD_TEAM)) {
+                handleTeamPacket(player, packet);
             }
         });
     }
@@ -128,4 +132,29 @@ private void handleDisplayPacket(Player player, PacketContainer packet) {
                     .ifPresent(objective -> scoreboard.sidebarObjective = null);
         }
     }
+
+    private void handleTeamPacket(Player player, PacketContainer packet) {
+        String teamId = packet.getStrings().read(0);
+        Optional<TeamMode> optMode = TeamMode.getMode(packet.getIntegers().read(0));
+
+        if (!optMode.isPresent() || teamId.length() > 16) {
+            return;
+        }
+
+        TeamMode mode = optMode.get();
+
+        PlayerScoreboard scoreboard = manager.getScoreboard(player);
+        if (mode == TeamMode.CREATE) {
+            Collection<String> members = packet.getSpecificModifier(Collection.class).read(0);
+            scoreboard.teamsByName.put(teamId, new Team(scoreboard, teamId, members));
+        } else if (mode == TeamMode.REMOVE) {
+            scoreboard.teamsByName.remove(teamId);
+        } else if (mode == TeamMode.ADD_MEMBER) {
+            Collection<String> members = packet.getSpecificModifier(Collection.class).read(0);
+            scoreboard.getTeam(teamId).ifPresent(team -> team.members.addAll(members));
+        } else if (mode == TeamMode.REMOVE_MEMBER) {
+            Collection<String> members = packet.getSpecificModifier(Collection.class).read(0);
+            scoreboard.getTeam(teamId).ifPresent(team -> team.members.removeAll(members));
+        }
+    }
 }

plugin/src/main/java/com/github/games647/scoreboardstats/scoreboard/PlayerScoreboard.java

@@ -19,6 +19,8 @@
 public class PlayerScoreboard {
 
     final Map<String, Objective> objectivesByName = Maps.newHashMap();
+    final Map<String, Team> teamsByName = Maps.newHashMap();
+
     private final Player player;
     Objective sidebarObjective;
 
@@ -27,12 +29,7 @@ public PlayerScoreboard(Player player) {
     }
 
     public Objective getOrCreateObjective(String objectiveId) {
-        Objective objective = objectivesByName.get(objectiveId);
-        if (objective == null) {
-            objective = addObjective(objectiveId);
-        }
-
-        return objective;
+        return objectivesByName.computeIfAbsent(objectiveId, this::addObjective);
     }
 
     public Optional<Objective> getObjective(String objectiveId) {
@@ -63,7 +60,32 @@ public Optional<Objective> getSidebarObjective() {
 
     public void removeObjective(String objectiveId) {
         Objective objective = objectivesByName.remove(objectiveId);
-        objective.sendObjectivePacket(State.REMOVE);
+        if (objective != null) {
+            objective.sendObjectivePacket(State.REMOVE);
+        }
+    }
+
+    public Optional<Team> getTeam(String teamId) {
+        return Optional.ofNullable(teamsByName.get(teamId));
+    }
+
+    public Team addTeam(String teamId) {
+        Team team = new Team(this, teamId);
+        teamsByName.put(teamId, team);
+
+        team.sendCreatePacket();
+        return team;
+    }
+
+    public Collection<Team> getTeams() {
+        return teamsByName.values();
+    }
+
+    public void removeTeam(String teamId) {
+        Team team = teamsByName.remove(teamId);
+        if (team != null) {
+            team.sendRemovePacket();
+        }
     }
 
     public Player getOwner() {

plugin/src/main/java/com/github/games647/scoreboardstats/scoreboard/Team.java

@@ -0,0 +1,91 @@
+package com.github.games647.scoreboardstats.scoreboard;
+
+import com.comphenix.protocol.PacketType.Play.Server;
+import com.comphenix.protocol.events.PacketContainer;
+import com.google.common.collect.ImmutableSet;
+import com.google.common.collect.Sets;
+
+import java.util.Collection;
+import java.util.Set;
+
+public class Team {
+
+    private final PlayerScoreboard scoreboard;
+    private final String teamId;
+
+    final Set<String> members = Sets.newHashSet();
+    String prefix;
+    String suffix;
+
+    public Team(PlayerScoreboard scoreboard, String teamId) {
+        this.scoreboard = scoreboard;
+        this.teamId = teamId;
+    }
+
+    public Team(PlayerScoreboard scoreboard, String teamId, Collection<String> members) {
+        this(scoreboard, teamId);
+
+        this.members.addAll(members);
+    }
+
+    public String getId() {
+        return teamId;
+    }
+
+    public boolean hasMember(String member) {
+        return members.contains(member);
+    }
+
+    public boolean addMember(String member) {
+        return members.add(member);
+    }
+
+    public boolean removeMember(String member) {
+        return members.remove(member);
+    }
+
+    public Set<String> getMembers() {
+        return ImmutableSet.copyOf(members);
+    }
+
+    public String getPrefix() {
+        return prefix;
+    }
+
+    public void setPrefix(String prefix) {
+        this.prefix = prefix;
+    }
+
+    public String getSuffix() {
+        return suffix;
+    }
+
+    public void setSuffix(String suffix) {
+        this.suffix = suffix;
+    }
+
+    void sendCreatePacket() {
+        PacketContainer packet = newPacket(TeamMode.CREATE);
+        packet.getSpecificModifier(Collection.class).write(0, ImmutableSet.copyOf(members));
+        scoreboard.sendPacket(packet);
+    }
+
+    void sendMemberUpdatePacket(boolean add) {
+        PacketContainer packet = newPacket(add ? TeamMode.ADD_MEMBER : TeamMode.REMOVE_MEMBER);
+        packet.getSpecificModifier(Collection.class).write(0, ImmutableSet.copyOf(members));
+        scoreboard.sendPacket(packet);
+    }
+
+    void sendRemovePacket() {
+        PacketContainer packet = newPacket(TeamMode.REMOVE);
+        scoreboard.sendPacket(packet);
+    }
+
+    private PacketContainer newPacket(TeamMode mode) {
+        PacketContainer packet = new PacketContainer(Server.SCOREBOARD_TEAM);
+        packet.getStrings().write(0, teamId);
+
+        packet.getIntegers().write(1, mode.ordinal());
+        return packet;
+    }
+}

plugin/src/main/java/com/github/games647/scoreboardstats/scoreboard/TeamMode.java

@@ -0,0 +1,25 @@
+package com.github.games647.scoreboardstats.scoreboard;
+
+import java.util.Optional;
+
+public enum TeamMode {
+
+    CREATE,
+
+    REMOVE,
+
+    UPDATE,
+
+    ADD_MEMBER,
+
+    REMOVE_MEMBER;
+
+    public static Optional<TeamMode> getMode(int id) {
+        TeamMode[] values = TeamMode.values();
+        if (id < 0 || id >= values.length) {
+            return Optional.empty();
+        }
+
+        return Optional.of(values[id]);
+    }
+}

pvp/src/main/java/com/github/games647/scoreboardstats/pvp/SignListener.java

@@ -56,7 +56,7 @@ private Optional<String> replace(Player player, String line) {
             if (line.contains(entry.getKey())) {
                 Function<PlayerStats, Integer> fct = entry.getValue();
                 return Optional.of(database.getStats(player)
-                        .map(fct::apply)
+                        .map(fct)
                         .map(value -> Integer.toString(value))
                         .orElse("Not loaded"));
             }

variables/src/main/java/com/github/games647/scoreboardstats/scoreboard/Score.java

@@ -1,8 +1,21 @@
 package com.github.games647.scoreboardstats.scoreboard;
 
+/**
+ * Represents a scoreboard score item or "line"
+ */
 public interface Score {
 
+    /**
+     * Get the current display name for the scoreboard score
+     *
+     * @return display name
+     */
     String getName();
 
+    /**
+     * Score value that is displayed next to the item
+     *
+     * @return the current score
+     */
     int getScore();
 }

variables/src/main/java/com/github/games647/scoreboardstats/variables/DefaultReplacer.java

@@ -6,12 +6,31 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+/**
+ * Represents that a replacer that is added to this plugin by this plugin itself.
+ */
 @Documented
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
 public @interface DefaultReplacer {
 
-    String plugin() default "";
+    /**
+     * Returns the required plugin that is needed to activate this variables. It defaults to
+     * this scoreboard plugin itself.
+     *
+     * @return the required plugin dependency for this variables
+     */
+    String plugin() default "ScoreboardStats";
 
+    /**
+     * Minimum required version to activate the replacers that will be registered. The version format
+     * have to be in semVer format major.minor.fix with
+     * <br>
+     * 1.2.3 is higher than 1.1.3
+     * <br>
+     * 2.5 higher than 1.0.0
+     *
+     * @return required version or empty for no required version
+     */
     String requiredVersion() default "";
 }

variables/src/main/java/com/github/games647/scoreboardstats/variables/DefaultReplacers.java

@@ -2,6 +2,11 @@
 
 import org.bukkit.plugin.Plugin;
 
+/**
+ * Represents a default replacers instance that will register default variables.
+ *
+ * @param <T> plugin class for easier access to the plugin field without casting
+ */
 public abstract class DefaultReplacers<T extends Plugin> {
 
     protected final ReplacerAPI replaceManager;
@@ -12,9 +17,21 @@ public DefaultReplacers(ReplacerAPI replaceManager, T plugin) {
         this.plugin = plugin;
     }
 
+    /**
+     * Register all variables that this class can manage
+     */
     public abstract void register();
 
+    /**
+     * Shortcut method to register the variables without the boilerplate of adding the plugin instance and registering
+     * it to the manager.
+     *
+     * @param variable variable name like "online"
+     * @return the replacer responsible for this single variable
+     */
     protected Replacer register(String variable) {
-        return new Replacer(plugin, variable);
+        Replacer replacer = new Replacer(plugin, variable);
+        replaceManager.register(replacer);
+        return replacer;
     }
 }