Skip to content

Commit

Permalink
cleanup ScoreboardHelper
Browse files Browse the repository at this point in the history
  • Loading branch information
@mcmonkey4eva
mcmonkey4eva committed Dec 27, 2023
1 parent 5cf15d9 commit 0c5a2b3
Showing 1 changed file with 38 additions and 176 deletions.
214 changes: 38 additions & 176 deletions plugin/src/main/java/com/denizenscript/denizen/utilities/ScoreboardHelper.java
View file
Expand Up @@ -12,111 +12,67 @@

import java.util.*;

/**
* Creates, saves and loads scoreboards
*/

/** Helper/manager for scoreboards that creates, saves, and loads scoreboards. */
public class ScoreboardHelper {

public static ScoreboardManager manager = Bukkit.getScoreboardManager();

// A map with scoreboard IDs as keys and scoreboards as values
/** A map with scoreboard IDs as keys and scoreboards as values. */
public static Map<String, Scoreboard> scoreboardMap = new HashMap<>();
// A map with viewer names as keys and scoreboard IDs as values

/** A map with viewer names as keys and scoreboard IDs as values. */
public static Map<UUID, String> viewerMap = new HashMap<>();

/*
* Called on server startup or /denizen reload saves
*/
/** Called on server startup or /denizen reload saves. */
public static void _recallScoreboards() {

// Clear every existing ingame scoreboard
for (Map.Entry<String, Scoreboard> entry : scoreboardMap.entrySet()) {
clearScoreboard(entry.getValue());
}

Scoreboard emptyBoard = createScoreboard();

// Clear every viewer's set scoreboard
for (Map.Entry<UUID, String> entry : viewerMap.entrySet()) {
OfflinePlayer player = Bukkit.getPlayer(entry.getKey());
if (player != null && player.isOnline()) {
player.getPlayer().setScoreboard(emptyBoard);
}
}

// Delete the contents of the scoreboardMap and viewerMap
scoreboardMap.clear();
viewerMap.clear();

ConfigurationSection rootSection = Denizen.getInstance()
.getScoreboards().getConfigurationSection("Scoreboards");

// Go no further if we have no scoreboards saved
ConfigurationSection rootSection = Denizen.getInstance().getScoreboards().getConfigurationSection("Scoreboards");
if (rootSection == null) {
return;
}

Scoreboard board;

// Iterate through scoreboards
for (String id : rootSection.getKeys(false)) {
// Create a scoreboard with this id
board = createScoreboard(id);

// Get the list of viewers
List<String> viewerList = rootSection.getStringList(id + ".Viewers");

// Iterate through viewers, store them in the viewerMap,
// and make them see this scoreboard if they are online
for (String viewer : viewerList) {
if (PlayerTag.matches(viewer)) {
PlayerTag player = PlayerTag.valueOf(viewer, CoreUtilities.basicContext);
viewerMap.put(player.getUUID(), id);

if (player.isOnline()) {
player.getPlayerEntity().setScoreboard(board);
}
}
}

ConfigurationSection objSection = rootSection
.getConfigurationSection(id + ".Objectives");

// Go no further if we have no objectives saved
ConfigurationSection objSection = rootSection.getConfigurationSection(id + ".Objectives");
if (objSection == null) {
return;
}

// Iterate through objectives
for (String obj : objSection.getKeys(false)) {
// Get display slot and criteria for this objective
String displaySlot = objSection.getString(obj + ".Display slot");
String criteria = objSection.getString(obj + ".Criteria");

// Use default criteria if necessary
if (criteria == null) {
criteria = "dummy";
}
// Use default display slot if necessary
if (displaySlot == null) {
displaySlot = "NONE";
}

// Register the objective and set it up
Objective o = board.registerNewObjective(obj, criteria);
o.setDisplayName(obj);

// Only set display slot if it's valid
Objective o = board.registerNewObjective(obj, Bukkit.getScoreboardCriteria(criteria), obj);
if (Argument.valueOf(displaySlot).matchesEnum(DisplaySlot.class)) {
o.setDisplaySlot(DisplaySlot.valueOf(displaySlot.toUpperCase()));
}

ConfigurationSection scoreSection = objSection
.getConfigurationSection(obj + ".Scores");

ConfigurationSection scoreSection = objSection.getConfigurationSection(obj + ".Scores");
if (scoreSection != null) {
// Iterate through scores and add them to this objective
for (String scoreName : scoreSection.getKeys(false)) {
int scoreInt = scoreSection.getInt(scoreName);
addScore(o, scoreName, scoreInt);
Expand All @@ -126,73 +82,41 @@ public static void _recallScoreboards() {
}
}

/*
* Called on server shutdown or /denizen save
*/
/** Called on server shutdown or /denizen save. */
public static void _saveScoreboards() {

try {
// Clear scoreboards.yml
Denizen.getInstance().getScoreboards()
.set("Scoreboards", null);

// Iterate through scoreboards map
Denizen.getInstance().getScoreboards().set("Scoreboards", null);
for (Map.Entry<String, Scoreboard> scoreboardEntry : scoreboardMap.entrySet()) {

String id = scoreboardEntry.getKey();
List<String> viewerList = new ArrayList<>();

// Find all of the viewers that are viewing this scoreboard
// and put them on a list
for (Map.Entry<UUID, String> viewerEntry : viewerMap.entrySet()) {
if (id.equalsIgnoreCase(viewerEntry.getValue())) {
viewerList.add(viewerEntry.getKey().toString());
}
}

// Save viewer list
Denizen.getInstance().getScoreboards()
.set("Scoreboards." + id + ".Viewers", viewerList);

// Iterate through objectives
Denizen.getInstance().getScoreboards().set("Scoreboards." + id + ".Viewers", viewerList);
for (Objective obj : scoreboardEntry.getValue().getObjectives()) {
String objPath = "Scoreboards." + id + ".Objectives."
+ obj.getName();

// Save criteria for this objective
Denizen.getInstance().getScoreboards()
.set(objPath + ".Criteria", obj.getCriteria());

String objPath = "Scoreboards." + id + ".Objectives." + obj.getName();
Denizen.getInstance().getScoreboards().set(objPath + ".Criteria", obj.getCriteria());
String displaySlot;
// If the display slot is null, save it as "NONE";
// otherwise, save it with its regular name
if (obj.getDisplaySlot() != null) {
displaySlot = obj.getDisplaySlot().name();
}
else {
displaySlot = "NONE";
}

Denizen.getInstance().getScoreboards()
.set(objPath + ".Display slot", displaySlot);

// There is no method for getting an objective's
// scores, so iterate through all of the scoreboard's
// players, check if they have a score for this
// objective, and save it if they do
for (String player : scoreboardEntry.getValue().getEntries()) {

int score = obj.getScore(player).getScore();
Team team = scoreboardEntry.getValue().getTeam(player);
// TODO: Properly save and load teams
player = (team != null && team.getPrefix() != null ? team.getPrefix() : "") + player + (team != null && team.getSuffix() != null ? team.getSuffix() : "");

// If a player has no score for this objective,
// getScore() will return 0, so ignore scores
// of 0
if (score != 0) {
Denizen.getInstance().getScoreboards()
.set(objPath + ".Scores." + player, score);
Denizen.getInstance().getScoreboards().set(objPath + ".Display slot", displaySlot);
if (obj.isModifiable()) {
// There is no method for getting an objective's scores, so iterate through all of the scoreboard's players, check if they have a score for this objective, and save it if they do
for (String player : scoreboardEntry.getValue().getEntries()) {
int score = obj.getScore(player).getScore();
Team team = scoreboardEntry.getValue().getTeam(player);
// TODO: Properly save and load teams
player = (team != null && team.getPrefix() != null ? team.getPrefix() : "") + player + (team != null && team.getSuffix() != null ? team.getSuffix() : "");
// If a player has no score for this objective, getScore() will return 0, so ignore scores of 0
if (score != 0) {
Denizen.getInstance().getScoreboards().set(objPath + ".Scores." + player, score);
}
}
}
}
Expand All @@ -203,20 +127,10 @@ public static void _saveScoreboards() {
}
}

/////////////////////
// OBJECTIVE METHODS
/////////////////

/**
* Add a score to an Objective for a name.
*
* @param o the Objective to add the score to
* @param score the score
*/
/** Add a score to an Objective for a name. */
public static void addScore(Objective o, String playerName, int score) {
Score sc = o.getScore(playerName);
// If the score is 0, it won't normally be displayed at first,
// so force it to be displayed by using setScore() like below on it
// If the score is 0, it won't normally be displayed at first, so force it to be displayed by using setScore() like below on it
if (score == 0) {
sc.setScore(1);
sc.setScore(0);
Expand All @@ -226,81 +140,43 @@ public static void addScore(Objective o, String playerName, int score) {
}
}

/**
* Remove a score from an Objective for a name.
*
* @param o the Objective to remove the score from
*/
/** Remove a score from an Objective for a name. */
public static void removeScore(Objective o, String playerName) {

// There is no method to remove a single score from an
// objective, as confirmed here:
// https://bukkit.atlassian.net/browse/BUKKIT-4014
//
// So use crazy workaround below
// There is no method to remove a single score from an objective, as confirmed here: https://bukkit.atlassian.net/browse/BUKKIT-4014
// So use crazy workaround below (save all scores, clear, and re-add)
Scoreboard board = o.getScoreboard();
Map<String, Integer> scoreMap = new HashMap<>();

// Go through every score for this (real or fake) player
// and put it in scoreMap if it doesn't belong to the
// objective we want to remove the score from
for (Score sc : board.getScores(playerName)) {
if (!sc.getObjective().equals(o)) {
scoreMap.put(sc.getObjective().getName(), sc.getScore());
}
}

// Remove all the scores for this (real or fake) player
board.resetScores(playerName);

// Go through scoreMap and add back all the scores we saved
// for this (real or fake) player
for (Map.Entry<String, Integer> entry : scoreMap.entrySet()) {
board.getObjective(entry.getKey()).getScore(playerName).setScore(entry.getValue());
}
}

/////////////////////
// SCOREBOARD METHODS
/////////////////

/**
* Clears all the objectives from a Scoreboard, making it empty.
*
* @param board the Scoreboard to clear
*/
/** Clears all the objectives from a Scoreboard, making it empty. */
public static void clearScoreboard(Scoreboard board) {
for (Objective o : board.getObjectives()) {
o.unregister();
}
}

/**
* Creates an anonymous new Scoreboard that isn't saved anywhere.
*
* @return the new Scoreboard
*/
/** Creates an anonymous new Scoreboard that isn't saved anywhere. */
public static Scoreboard createScoreboard() {
return manager.getNewScoreboard();
}

/**
* Creates a new Scoreboard with a certain id and stories it in the scoreboards map.
*
* @param id the id of the new Scoreboard
* @return the new Scoreboard
*/
/** Creates a new Scoreboard with a certain id and stories it in the scoreboards map. */
public static Scoreboard createScoreboard(String id) {
Scoreboard board = manager.getNewScoreboard();
scoreboardMap.put(id.toUpperCase(), board);
return board;
}

/**
* Deletes a Scoreboard, clearing it and removing it from the scoreboards map, unless it is the server's main scoreboard, in which case it is just cleared.
*
* @param id the id of the Scoreboard
*/
/** Deletes a Scoreboard, clearing it and removing it from the scoreboards map, unless it is the server's main scoreboard, in which case it is just cleared. */
public static void deleteScoreboard(String id) {
if (id.equalsIgnoreCase("main")) {
clearScoreboard(getMain());
Expand All @@ -311,31 +187,17 @@ public static void deleteScoreboard(String id) {
}
}

/**
* Returns the server's main scoreboard, that isn't stored in the scoreboards map because Bukkit already saves it by itself.
*
* @return the main Scoreboard
*/
/** Returns the server's main scoreboard, that isn't stored in the scoreboards map because Bukkit already saves it by itself. */
public static Scoreboard getMain() {
return manager.getMainScoreboard();
}

/**
* Returns a Scoreboard from the scoreboards map.
*
* @param id the id of the Scoreboard
* @return the Scoreboard returned
*/
/** Returns a Scoreboard from the scoreboards map. */
public static Scoreboard getScoreboard(String id) {
return scoreboardMap.get(id.toUpperCase());
}

/**
* Returns true if the scoreboards map contains a certain scoreboard id.
*
* @param id the id of the Scoreboard
* @return true or false
*/
/** Returns true if the scoreboards map contains a certain scoreboard id. */
public static boolean hasScoreboard(String id) {
return scoreboardMap.containsKey(id.toUpperCase());
}
Expand Down

0 comments on commit 0c5a2b3

Please sign in to comment.