Add scoreboards

Author: Pablete1234

src/main/java/in/twizmwaz/cardinal/module/objective/Objective.java

@@ -49,6 +49,10 @@ public abstract class Objective {
   private final boolean required;
   protected final boolean show;
 
+  /**
+   * Gets the objective display name.
+   * @return The display name.
+   */
   public abstract UnlocalizedComponent getComponent();
 
   /**
@@ -59,9 +63,9 @@ public abstract class Objective {
   public static List<Objective> getObjectives(@NonNull Match match) {
     List<Objective> objectives = Lists.newArrayList();
 
-    Cardinal.getModule(CoreModule.class).getCores(match).forEach(objectives::add);
-    Cardinal.getModule(DestroyableModule.class).getDestroyables(match).forEach(objectives::add);
-    Cardinal.getModule(WoolModule.class).getWools(match).forEach(objectives::add);
+    objectives.addAll(Cardinal.getModule(WoolModule.class).getWools(match));
+    objectives.addAll(Cardinal.getModule(CoreModule.class).getCores(match));
+    objectives.addAll(Cardinal.getModule(DestroyableModule.class).getDestroyables(match));
 
     return objectives;
   }

src/main/java/in/twizmwaz/cardinal/module/objective/OwnedObjective.java

@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) 2016, Kevin Phoenix
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package in.twizmwaz.cardinal.module.objective;
+
+import ee.ellytr.chat.component.formattable.UnlocalizedComponent;
+import in.twizmwaz.cardinal.module.team.Team;
+
+public interface OwnedObjective {
+
+  Team getOwner();
+
+  String getPrefix(Team viewer, Team attacker);
+
+  UnlocalizedComponent getComponent();
+
+}

src/main/java/in/twizmwaz/cardinal/module/objective/core/Core.java

@@ -39,24 +39,27 @@
 import in.twizmwaz.cardinal.module.filter.type.TeamFilter;
 import in.twizmwaz.cardinal.module.filter.type.modifiers.TransformFilter;
 import in.twizmwaz.cardinal.module.objective.Objective;
+import in.twizmwaz.cardinal.module.objective.OwnedObjective;
 import in.twizmwaz.cardinal.module.objective.ProximityMetric;
 import in.twizmwaz.cardinal.module.region.Region;
 import in.twizmwaz.cardinal.module.region.type.FiniteBlockRegion;
+import in.twizmwaz.cardinal.module.scoreboard.displayables.EntryHolder;
+import in.twizmwaz.cardinal.module.scoreboard.displayables.EntryUpdater;
 import in.twizmwaz.cardinal.module.team.Team;
+import in.twizmwaz.cardinal.util.Characters;
 import in.twizmwaz.cardinal.util.MaterialPattern;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
-import lombok.Setter;
+import net.md_5.bungee.api.ChatColor;
 import org.bukkit.Material;
 import org.bukkit.entity.Player;
-import org.bukkit.event.Listener;
 
 import java.util.AbstractMap;
 import java.util.List;
 
 @Data
 @EqualsAndHashCode(callSuper = true)
-public class Core extends Objective implements Listener {
+public class Core extends Objective implements OwnedObjective, EntryUpdater {
 
   private static final MaterialPattern lavaPattern = new MaterialPattern(
           new AbstractMap.SimpleEntry<>(Material.LAVA, MaterialPattern.ANY_DATA_VALUE),
@@ -71,10 +74,11 @@ public class Core extends Objective implements Listener {
   private final ProximityMetric proximityMetric;
   private final boolean proximityHorizontal;
 
+  private final EntryHolder entryHolder = new EntryHolder();
+
   private final List<Player> touchedPlayers = Lists.newArrayList();
+  private final List<Team> touchedTeams = Lists.newArrayList();
 
-  @Setter
-  private boolean touched;
   private boolean complete;
 
   /**
@@ -85,7 +89,7 @@ public class Core extends Objective implements Listener {
    * @param region              The region that contains this core.
    * @param leak                The distance required for the lava to be from the core in order to be leaked.
    * @param material            The material that the core is made out of.
-   * @param owner               The owner that owns this core.
+   * @param owner               The team that owns this core.
    * @param modeChanges         Determines if this core follows mode changes.
    * @param show                Determines if this core shows on the scoreboard.
    * @param proximityMetric     The proximity metric for proximity tracking of this core.
@@ -118,6 +122,43 @@ public Core(Match match, String id, String name, boolean required, Region region
         true);
   }
 
+  public boolean isTouched(Team team) {
+    return touchedTeams.contains(team);
+  }
+
+  /**
+   * Sets the core as touched for a certain team. Scoreboard entries will be updated.
+   * @param team The team that touched the core.
+   */
+  public void setTouched(Team team) {
+    if (!isTouched(team)) {
+      touchedTeams.add(team);
+      entryHolder.updateEntries();
+    }
+  }
+
+  public void setComplete(boolean complete) {
+    this.complete = complete;
+    entryHolder.updateEntries();
+  }
+
+  /**
+   * Gets the monument prefix for a given viewer team, for a specific attacker
+   * @param viewer The viewer team, null for observers.
+   * @param attacker The team attacking the objective. Used to see if the team has a touch or not.
+   * @return Color and wool state character. Always 3 characters.
+   */
+  @Override
+  public String getPrefix(Team viewer, Team attacker) {
+    if (isComplete()) {
+      return "" + ChatColor.GREEN + Characters.CORE_COMPLETED;
+    } else if (isTouched(attacker) && (viewer == null || viewer.equals(attacker))) {
+      return "" + ChatColor.YELLOW + Characters.CORE_TOUCHED;
+    } else {
+      return "" + ChatColor.RED + Characters.CORE_INCOMPLETE;
+    }
+  }
+
   @Override
   public UnlocalizedComponent getComponent() {
     return new UnlocalizedComponent(name);

src/main/java/in/twizmwaz/cardinal/module/objective/core/CoreModule.java

@@ -58,7 +58,6 @@
 import org.bukkit.entity.Player;
 import org.bukkit.event.EventHandler;
 import org.bukkit.event.EventPriority;
-import org.bukkit.event.HandlerList;
 import org.bukkit.event.block.BlockBreakEvent;
 import org.bukkit.event.block.BlockFromToEvent;
 import org.bukkit.event.entity.PlayerDeathEvent;
@@ -191,9 +190,7 @@ public boolean loadMatch(Match match) {
 
   @Override
   public void clearMatch(Match match) {
-    List<Core> cores = this.cores.get(match);
-    cores.forEach(HandlerList::unregisterAll);
-    cores.clear();
+    this.cores.get(match).clear();
     this.cores.remove(match);
   }
 
@@ -235,7 +232,7 @@ public void onBlockBreak(BlockBreakEvent event) {
     Block block = event.getBlock();
     cores.get(match).forEach(core -> {
       if (core.getRegion().contains(block.getLocation())) {
-        core.setTouched(true);
+        core.setTouched(team);
         if (core.isShow() && !core.getTouchedPlayers().contains(player)) {
           core.getTouchedPlayers().add(player);
           Channels.getTeamChannel(match, team).sendPrefixedMessage(

src/main/java/in/twizmwaz/cardinal/module/objective/destroyable/Destroyable.java

@@ -46,14 +46,19 @@
 import in.twizmwaz.cardinal.module.filter.type.modifiers.AllFilter;
 import in.twizmwaz.cardinal.module.filter.type.modifiers.TransformFilter;
 import in.twizmwaz.cardinal.module.objective.Objective;
+import in.twizmwaz.cardinal.module.objective.OwnedObjective;
 import in.twizmwaz.cardinal.module.objective.ProximityMetric;
 import in.twizmwaz.cardinal.module.region.Region;
 import in.twizmwaz.cardinal.module.region.type.FiniteBlockRegion;
+import in.twizmwaz.cardinal.module.scoreboard.displayables.EntryHolder;
+import in.twizmwaz.cardinal.module.scoreboard.displayables.EntryUpdater;
 import in.twizmwaz.cardinal.module.team.Team;
 import in.twizmwaz.cardinal.playercontainer.PlayingPlayerContainer;
 import in.twizmwaz.cardinal.util.Channels;
+import in.twizmwaz.cardinal.util.Characters;
 import in.twizmwaz.cardinal.util.Components;
 import in.twizmwaz.cardinal.util.MaterialPattern;
+import in.twizmwaz.cardinal.util.Numbers;
 import lombok.Getter;
 import lombok.NonNull;
 import lombok.Setter;
@@ -70,7 +75,7 @@
 import java.util.UUID;
 
 @Getter
-public class Destroyable extends Objective {
+public class Destroyable extends Objective implements OwnedObjective, EntryUpdater {
 
   private final String name;
   private final Region region;
@@ -84,7 +89,10 @@ public class Destroyable extends Objective {
   private final ProximityMetric proximityMetric;
   private final boolean proximityHorizontal;
 
+  private final EntryHolder entryHolder = new EntryHolder();
+
   private final List<Player> touchedPlayers = new ArrayList<>();
+  private final List<Team> touchedTeams = new ArrayList<>();
   private final Map<UUID, Integer> playerContributions = new HashMap<>();
 
   @Setter
@@ -141,6 +149,21 @@ public Destroyable(Match match, String id, String name, boolean required, Region
         true);
   }
 
+  public boolean isTouched(Team team) {
+    return touchedTeams.contains(team);
+  }
+
+  /**
+   * Sets the destroyable as touched for a certain team. Scoreboard entries will be updated.
+   * @param team The team that touched the destroyable.
+   */
+  public void setTouched(Team team) {
+    if (!isTouched(team)) {
+      touchedTeams.add(team);
+      entryHolder.updateEntries();
+    }
+  }
+
   public boolean isPartOf(@NonNull Block block) {
     return region.contains(block.getLocation())
         && materials.contains(block.getType(), (int) block.getState().getMaterialData().getData());
@@ -156,6 +179,7 @@ public void addBrokenPiecesFor(Player player, int contribution) {
     PlayingPlayerContainer container = match.getPlayingContainer(player);
     if (!isCompleted() && container instanceof Team) {
       Team team = (Team) container;
+      setTouched(team);
       if (show && !touchedPlayers.contains(player)) {
         touchedPlayers.add(player);
         Channels.getTeamChannel(match, team).sendPrefixedMessage(
@@ -187,9 +211,21 @@ public void addBrokenPiecesFor(Player player, int contribution) {
       } else {
         Bukkit.getPluginManager().callEvent(new ObjectiveTouchEvent(this, player));
       }
+      entryHolder.updateEntries();
     }
   }
 
+  /**
+   * Gets the completion percentage.
+   * @return The percentage, always between 0 and 100;
+   */
+  public int getPercent() {
+    if (isCompleted()) {
+      return 100;
+    }
+    return (int) Numbers.between(Math.floor((double) broken / (total * completion) * 100), 0, 100);
+  }
+
   private ListComponent getContributionList() {
     List<BaseComponent> contributions = new ArrayList<>();
     playerContributions.forEach((uuid, amount) -> {
@@ -201,6 +237,27 @@ private ListComponent getContributionList() {
     return new ListComponent(contributions);
   }
 
+  /**
+   * Gets the monument prefix for a given viewer team, for a specific attacker.
+   * @param viewer The viewer team, null for observers.
+   * @param attacker The team attacking the objective. Used to see if the team has a touch or not.
+   * @return Color and monument state or percentage. Always between 3 and 6 characters (color + "100%").
+   */
+  @Override
+  public String getPrefix(Team viewer, Team attacker) {
+    if (isCompleted()) {
+      return ChatColor.GREEN + getCompletionOrCharacter(viewer, Characters.CORE_COMPLETED);
+    } else if (isTouched(attacker) && (viewer == null || viewer.equals(attacker))) {
+      return ChatColor.YELLOW + getCompletionOrCharacter(viewer, Characters.CORE_TOUCHED);
+    } else {
+      return ChatColor.RED + getCompletionOrCharacter(viewer, Characters.CORE_INCOMPLETE);
+    }
+  }
+
+  private String getCompletionOrCharacter(Team viewer, Characters character) {
+    return viewer == null || isShowProgress() ? getPercent() + "%" : character + "";
+  }
+
   @Override
   public UnlocalizedComponent getComponent() {
     return new UnlocalizedComponent(name);

src/main/java/in/twizmwaz/cardinal/module/objective/wool/Wool.java

@@ -31,7 +31,10 @@
 import in.twizmwaz.cardinal.module.objective.Objective;
 import in.twizmwaz.cardinal.module.objective.ProximityRule;
 import in.twizmwaz.cardinal.module.region.Region;
+import in.twizmwaz.cardinal.module.scoreboard.displayables.EntryHolder;
+import in.twizmwaz.cardinal.module.scoreboard.displayables.EntryUpdater;
 import in.twizmwaz.cardinal.module.team.Team;
+import in.twizmwaz.cardinal.util.Characters;
 import in.twizmwaz.cardinal.util.Colors;
 import in.twizmwaz.cardinal.util.Strings;
 import lombok.Data;
@@ -48,7 +51,7 @@
 
 @Data
 @EqualsAndHashCode(callSuper = true)
-public class Wool extends Objective implements Listener {
+public class Wool extends Objective implements Listener, EntryUpdater {
 
   private final Team team;
   private final DyeColor color;
@@ -58,6 +61,8 @@ public class Wool extends Objective implements Listener {
   private final ProximityRule woolProximityRule;
   private final ProximityRule monumentProximityRule;
 
+  private final EntryHolder entryHolder = new EntryHolder();
+
   private final List<Player> touchedPlayers = new ArrayList<>();
 
   private boolean touched;
@@ -90,6 +95,23 @@ public Wool(Match match, String id, boolean required, Team team, DyeColor color,
     this.monumentProximityRule = monumentProximityRule;
   }
 
+  /**
+   * Gets the wool prefix for a given viewer team.
+   * @param viewer The viewer team, null for observers.
+   * @return Color and wool state character. Always 3 characters.
+   */
+  public String getPrefix(Team viewer) {
+    String result = Colors.convertDyeToChatColor(color) + "";
+    if (isComplete()) {
+      result += Characters.WOOL_COMPLETED;
+    } else if (isTouched() && (viewer == null || viewer.equals(team))) {
+      result += Characters.WOOL_TOUCHED;
+    } else {
+      result += Characters.WOOL_INCOMPLETE;
+    }
+    return result;
+  }
+
   @Override
   public UnlocalizedComponent getComponent() {
     return new UnlocalizedComponentBuilder(
@@ -109,4 +131,14 @@ public void removePlayerTouched(@NonNull Player player) {
     touchedPlayers.remove(player);
   }
 
+  public void setTouched(boolean touched) {
+    this.touched = touched;
+    entryHolder.updateEntries();
+  }
+
+  public void setComplete(boolean complete) {
+    this.complete = complete;
+    entryHolder.updateEntries();
+  }
+
 }