"Deprecated" current placeholders (their name need to be changed) and…

… their implementation
BentoBoxWorld · Nov 23, 2019 · 8181fbc · 8181fbc
1 parent f97a252
commit 8181fbc
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 2 deletions.
diff --git a/src/main/java/world/bentobox/level/Level.java b/src/main/java/world/bentobox/level/Level.java
@@ -143,6 +143,8 @@ public void onEnable() {
             });
             // Register placeholders
             if (getPlugin().getPlaceholdersManager() != null) {
+                // DEPRECATED PLACEHOLDERS - remove in an upcoming version
+
                 getPlugin().getPlaceholdersManager().registerPlaceholder(this, gm.getDescription().getName().toLowerCase() + "-island-level", new LevelPlaceholder(this, gm));
                 // Top Ten
                 for (int i = 1; i < 11; i++) {

diff --git a/src/main/java/world/bentobox/level/placeholders/LevelPlaceholder.java b/src/main/java/world/bentobox/level/placeholders/LevelPlaceholder.java
@@ -8,7 +8,9 @@
 /**
  * @author tastybento
  *
+ * @deprecated As of 1.9.0, for removal.
  */
+@Deprecated
 public class LevelPlaceholder implements PlaceholderReplacer {
 
     private final Level addon;
@@ -29,6 +31,9 @@ public LevelPlaceholder(Level addon, GameModeAddon gm) {
      */
     @Override
     public String onReplace(User user) {
+        addon.logWarning("You are using a deprecated placeholder.");
+        addon.log("Please replace any occurrence of 'Level_" + gm.getDescription().getName().toLowerCase() + "-island-level'");
+        addon.log("by 'Level_" + gm.getDescription().getName().toLowerCase() + "_island_level'");
         return addon.getLevelPresenter().getLevelString(addon.getIslandLevel(gm.getOverWorld(), user.getUniqueId()));
     }
 

diff --git a/src/main/java/world/bentobox/level/placeholders/TopTenNamePlaceholder.java b/src/main/java/world/bentobox/level/placeholders/TopTenNamePlaceholder.java
@@ -10,8 +10,9 @@
 
 /**
  * @author tastybento
- *
+ * @deprecated As of 1.9.0, for removal.
  */
+@Deprecated
 public class TopTenNamePlaceholder implements PlaceholderReplacer {
 
     private final Level level;
@@ -29,6 +30,9 @@ public TopTenNamePlaceholder(Level level, GameModeAddon gm, int i) {
      */
     @Override
     public String onReplace(User user) {
+        level.logWarning("You are using a deprecated placeholder.");
+        level.log("Please replace any occurrence of 'Level_" + gm.getDescription().getName().toLowerCase() + "-island-top-name-#'");
+        level.log("by 'Level_" + gm.getDescription().getName().toLowerCase() + "_island_top_name_#'");
         Collection<UUID> values = level.getTopTen().getTopTenList(gm.getOverWorld()).getTopTen().keySet();
         return values.size() < i ? "" : level.getPlayers().getName(values.stream().skip(i).findFirst().orElse(null));
     }

diff --git a/src/main/java/world/bentobox/level/placeholders/TopTenPlaceholder.java b/src/main/java/world/bentobox/level/placeholders/TopTenPlaceholder.java
@@ -10,8 +10,9 @@
 /**
  * Provides the level values to placeholders
  * @author tastybento
- *
+ * @deprecated As of 1.9.0, for removal.
  */
+@Deprecated
 public class TopTenPlaceholder implements PlaceholderReplacer {
 
     private final Level level;
@@ -29,6 +30,9 @@ public TopTenPlaceholder(Level level, GameModeAddon gm, int i) {
      */
     @Override
     public String onReplace(User user) {
+        level.logWarning("You are using a deprecated placeholder.");
+        level.log("Please replace any occurrence of 'Level_" + gm.getDescription().getName().toLowerCase() + "-island-top-value-#'");
+        level.log("by 'Level_" + gm.getDescription().getName().toLowerCase() + "_island_top_value_#'");
         Collection<Long> values = level.getTopTen().getTopTenList(gm.getOverWorld()).getTopTen().values();
         return values.size() < i ? "" : values.stream().skip(i).findFirst().map(String::valueOf).orElse("");
     }