Javadoc changes

Fixed DeluxeCombat integration

eco-api/src/main/java/com/willfp/eco/core/config/base/LangYml.java

@@ -24,7 +24,7 @@ public class LangYml extends YamlBaseConfig {
      * @return The prefix.
      */
     public String getPrefix() {
-        return this.getString("messages.prefix");
+        return this.getFormattedString("messages.prefix");
     }
 
     /**
@@ -33,7 +33,7 @@ public class LangYml extends YamlBaseConfig {
      * @return The message.
      */
     public String getNoPermission() {
-        return getPrefix() + this.getString("messages.no-permission");
+        return getPrefix() + this.getFormattedString("messages.no-permission");
     }
 
     /**
@@ -55,6 +55,6 @@ public class LangYml extends YamlBaseConfig {
      */
     public String getMessage(@NotNull final String message,
                              @NotNull final StringUtils.FormatOption option) {
-        return getPrefix() + this.getString("messages." + message, option);
+        return getPrefix() + this.getFormattedString("messages." + message, option);
     }
 }

eco-api/src/main/java/com/willfp/eco/core/config/interfaces/Config.java

@@ -11,6 +11,7 @@ import java.util.List;
  * <p>
  * Contains all methods that must exist in yaml and json configurations.
  */
+@SuppressWarnings("unused")
 public interface Config extends Cloneable {
     /**
      * Clears cache.
@@ -159,8 +160,34 @@ public interface Config extends Cloneable {
     @Nullable
     List<Boolean> getBoolsOrNull(@NotNull String path);
 
+    /**
+     * Get a formatted string from config.
+     *
+     * @param path The key to fetch the value from.
+     * @return The found value, or an empty string if not found.
+     */
+    @NotNull
+    default String getFormattedString(@NotNull String path) {
+        return getString(path, true);
+    }
+
+    /**
+     * Get a formatted string from config.
+     *
+     * @param path   The key to fetch the value from.
+     * @param option The format option.
+     * @return The found value, or an empty string if not found.
+     */
+    @NotNull
+    default String getFormattedString(@NotNull String path,
+                                      @NotNull StringUtils.FormatOption option) {
+        return getString(path, true, option);
+    }
+
     /**
      * Get a string from config.
+     * <p>
+     * Formatted by default.
      *
      * @param path The key to fetch the value from.
      * @return The found value, or an empty string if not found.
@@ -172,12 +199,13 @@ public interface Config extends Cloneable {
 
     /**
      * Get a string from config.
+     * <p>
+     * This will be deprecated when {@link Config#getString(String)} no longer formats by default.
      *
      * @param path   The key to fetch the value from.
      * @param format If the string should be formatted.
      * @return The found value, or an empty string if not found.
      */
-    @NotNull
     default String getString(@NotNull String path,
                              boolean format) {
         return this.getString(path, format, StringUtils.FormatOption.WITH_PLACEHOLDERS);
@@ -189,8 +217,10 @@ public interface Config extends Cloneable {
      * @param path   The key to fetch the value from.
      * @param option The format option.
      * @return The found value, or an empty string if not found.
+     * @deprecated Use {@link Config#getFormattedString(String, StringUtils.FormatOption)} instead.
      */
     @NotNull
+    @Deprecated
     default String getString(@NotNull String path,
                              @NotNull final StringUtils.FormatOption option) {
         return this.getString(path, true, option);
@@ -209,8 +239,34 @@ public interface Config extends Cloneable {
                      boolean format,
                      @NotNull StringUtils.FormatOption option);
 
+    /**
+     * Get a formatted string from config.
+     *
+     * @param path The key to fetch the value from.
+     * @return The found value, or an empty string if not found.
+     */
+    @Nullable
+    default String getFormattedStringOrNull(@NotNull String path) {
+        return getStringOrNull(path, true);
+    }
+
+    /**
+     * Get a formatted string from config.
+     *
+     * @param path   The key to fetch the value from.
+     * @param option The format option.
+     * @return The found value, or an empty string if not found.
+     */
+    @Nullable
+    default String getFormattedStringOrNull(@NotNull String path,
+                                            @NotNull StringUtils.FormatOption option) {
+        return getStringOrNull(path, true, option);
+    }
+
     /**
      * Get a string from config.
+     * <p>
+     * Formatted by default.
      *
      * @param path The key to fetch the value from.
      * @return The found value, or null if not found.
@@ -222,6 +278,8 @@ public interface Config extends Cloneable {
 
     /**
      * Get a string from config.
+     * <p>
+     * This will be deprecated when {@link Config#getStringOrNull(String)} no longer formats by default.
      *
      * @param path   The key to fetch the value from.
      * @param format If the string should be formatted.
@@ -239,8 +297,10 @@ public interface Config extends Cloneable {
      * @param path   The key to fetch the value from.
      * @param option The format option.
      * @return The found value, or null if not found.
+     * @deprecated Use {@link Config#getFormattedString(String, StringUtils.FormatOption)} instead.
      */
     @Nullable
+    @Deprecated
     default String getStringOrNull(@NotNull String path,
                                    @NotNull StringUtils.FormatOption option) {
         return this.getStringOrNull(path, true, option);
@@ -251,7 +311,7 @@ public interface Config extends Cloneable {
      *
      * @param path   The key to fetch the value from.
      * @param format If the string should be formatted.
-     * @param option The format option.
+     * @param option The format option. If format is false, this will be ignored.
      * @return The found value, or null if not found.
      */
     @Nullable
@@ -268,12 +328,44 @@ public interface Config extends Cloneable {
      * @return The found value, or a blank {@link java.util.ArrayList} if not found.
      */
     @NotNull
+    default List<String> getFormattedStrings(@NotNull String path) {
+        return getStrings(path, true, StringUtils.FormatOption.WITH_PLACEHOLDERS);
+    }
+
+    /**
+     * Get a list of strings from config.
+     * <p>
+     * Formatted by default.
+     *
+     * @param path   The key to fetch the value from.
+     * @param option The format option.
+     * @return The found value, or a blank {@link java.util.ArrayList} if not found.
+     */
+    @NotNull
+    default List<String> getFormattedStrings(@NotNull String path,
+                                             @NotNull StringUtils.FormatOption option) {
+        return getStrings(path, true, option);
+    }
+
+    /**
+     * Get a list of strings from config.
+     * <p>
+     * Formatted by default.
+     * <p>
+     * This will be changed in newer versions to <b>not</b> format by default.
+     *
+     * @param path The key to fetch the value from.
+     * @return The found value, or a blank {@link java.util.ArrayList} if not found.
+     */
+    @NotNull
     default List<String> getStrings(@NotNull String path) {
         return getStrings(path, true);
     }
 
     /**
      * Get a list of strings from config.
+     * <p>
+     * This will be deprecated when {@link Config#getStrings(String)} no longer formats by default.
      *
      * @param path   The key to fetch the value from.
      * @param format If the strings should be formatted.
@@ -291,8 +383,10 @@ public interface Config extends Cloneable {
      * @param path   The key to fetch the value from.
      * @param option The format option.
      * @return The found value, or a blank {@link java.util.ArrayList} if not found.
+     * @deprecated Use {@link Config#getFormattedStrings(String, StringUtils.FormatOption)} instead.
      */
-    @Nullable
+    @NotNull
+    @Deprecated
     default List<String> getStrings(@NotNull String path,
                                     @NotNull StringUtils.FormatOption option) {
         return getStrings(path, true, option);
@@ -313,6 +407,38 @@ public interface Config extends Cloneable {
 
     /**
      * Get a list of strings from config.
+     * <p>
+     * Formatted by default.
+     *
+     * @param path The key to fetch the value from.
+     * @return The found value, or null if not found.
+     */
+    @Nullable
+    default List<String> getFormattedStringsOrNull(@NotNull String path) {
+        return getStringsOrNull(path, true, StringUtils.FormatOption.WITH_PLACEHOLDERS);
+    }
+
+    /**
+     * Get a list of strings from config.
+     * <p>
+     * Formatted by default.
+     *
+     * @param path   The key to fetch the value from.
+     * @param option The format option.
+     * @return The found value, or null if not found.
+     */
+    @Nullable
+    default List<String> getFormattedStringsOrNull(@NotNull String path,
+                                                   @NotNull StringUtils.FormatOption option) {
+        return getStringsOrNull(path, true, option);
+    }
+
+    /**
+     * Get a list of strings from config.
+     * <p>
+     * Formatted by default.
+     * <p>
+     * This will be changed in newer versions to <b>not</b> format by default.
      *
      * @param path The key to fetch the value from.
      * @return The found value, or null if not found.
@@ -341,8 +467,10 @@ public interface Config extends Cloneable {
      * @param path   The key to fetch the value from.
      * @param option The format option.
      * @return The found value, or null if not found.
+     * @deprecated Use {@link Config#getFormattedStringsOrNull(String, StringUtils.FormatOption)} instead.
      */
     @Nullable
+    @Deprecated
     default List<String> getStringsOrNull(@NotNull String path,
                                           @NotNull StringUtils.FormatOption option) {
         return getStringsOrNull(path, true, option);

eco-core/core-plugin/src/main/java/com/willfp/eco/spigot/recipes/ShapedRecipeListener.java

@@ -10,6 +10,7 @@ import com.willfp.eco.core.recipe.parts.ModifiedTestableItem;
 import com.willfp.eco.core.recipe.parts.TestableStack;
 import com.willfp.eco.core.recipe.recipes.CraftingRecipe;
 import com.willfp.eco.core.recipe.recipes.ShapedCraftingRecipe;
+import org.bukkit.Keyed;
 import org.bukkit.Material;
 import org.bukkit.event.Event;
 import org.bukkit.event.EventHandler;
@@ -245,7 +246,7 @@ public class ShapedRecipeListener extends PluginDependent<EcoPlugin> implements
     
     @EventHandler
     public void preventUsingComplexPartInVanillaRecipe(@NotNull final PrepareItemCraftEvent event) {
-        if (!(event.getRecipe() instanceof ShapedRecipe recipe)) {
+        if (!(event.getRecipe() instanceof Keyed recipe)) {
             return;
         }
 
@@ -263,7 +264,7 @@ public class ShapedRecipeListener extends PluginDependent<EcoPlugin> implements
 
     @EventHandler
     public void preventUsingComplexPartInVanillaRecipe(@NotNull final CraftItemEvent event) {
-        if (!(event.getRecipe() instanceof ShapedRecipe recipe)) {
+        if (!(event.getRecipe() instanceof Keyed recipe)) {
             return;
         }
 

eco-core/core-plugin/src/main/kotlin/com/willfp/eco/spigot/integrations/antigrief/AntigriefDeluxeCombat.kt

@@ -27,7 +27,7 @@ class AntigriefDeluxeCombat: AntigriefWrapper {
     override fun canInjure(player: Player, victim: LivingEntity): Boolean {
         val api = DeluxeCombatAPI()
         return when(victim) {
-            is Player -> (api.hasProtection(victim) || !api.hasPvPEnabled(victim)) && !api.isInCombat(victim)
+            is Player -> ((!api.hasProtection(victim) && api.hasPvPEnabled(victim)) || api.isInCombat(victim))
             else -> true
         }
     }

eco-core/core-plugin/src/main/kotlin/com/willfp/eco/spigot/integrations/antigrief/AntigriefIridiumSkyblock.kt

@@ -9,12 +9,12 @@ import org.bukkit.entity.LivingEntity
 import org.bukkit.entity.Player
 
 class AntigriefIridiumSkyblock : AntigriefWrapper {
-    private val api = IridiumSkyblockAPI.getInstance()
-
     override fun canBreakBlock(
         player: Player,
         block: Block
     ): Boolean {
+        val api = IridiumSkyblockAPI.getInstance() ?: return true
+
         return api.getIslandPermission(api.getIslandViaLocation(block.location).orElse(null) ?: return true, api.getUser(player), PermissionType.BLOCK_BREAK)
     }
 
@@ -22,6 +22,8 @@ class AntigriefIridiumSkyblock : AntigriefWrapper {
         player: Player,
         location: Location
     ): Boolean {
+        val api = IridiumSkyblockAPI.getInstance() ?: return true
+
         return api.getIslandPermission(api.getIslandViaLocation(location).orElse(null) ?: return true, api.getUser(player), PermissionType.BLOCK_BREAK)
     }
 
@@ -29,6 +31,8 @@ class AntigriefIridiumSkyblock : AntigriefWrapper {
         player: Player,
         block: Block
     ): Boolean {
+        val api = IridiumSkyblockAPI.getInstance() ?: return true
+
         return api.getIslandPermission(api.getIslandViaLocation(block.location).orElse(null) ?: return true, api.getUser(player), PermissionType.BLOCK_PLACE)
     }
 
@@ -36,6 +40,8 @@ class AntigriefIridiumSkyblock : AntigriefWrapper {
         player: Player,
         victim: LivingEntity
     ): Boolean {
+        val api = IridiumSkyblockAPI.getInstance() ?: return true
+
         return when (victim) {
             is Player -> api.getIslandViaLocation(victim.location).orElse(null) != null
             else -> api.getIslandPermission(api.getIslandViaLocation(victim.location).orElse(null) ?: return true, api.getUser(player), PermissionType.KILL_MOBS)

eco-core/core-plugin/src/main/kotlin/com/willfp/eco/spigot/integrations/antigrief/AntigriefSuperiorSkyblock2.kt

@@ -17,24 +17,32 @@ class AntigriefSuperiorSkyblock2 : AntigriefWrapper {
     }
 
     override fun canBreakBlock(player: Player, block: Block): Boolean {
-        if (SuperiorSkyblockAPI.getPlayer(player).hasBypassModeEnabled()) return true
+        if (SuperiorSkyblockAPI.getPlayer(player).hasBypassModeEnabled()) {
+            return true
+        }
         return SuperiorSkyblockAPI.getPlayer(player).hasPermission(IslandPrivilege.getByName("Break"))
                 || SuperiorSkyblockAPI.getPlayer(player).hasPermission(IslandPrivilege.getByName("BREAK"))
     }
 
     override fun canCreateExplosion(player: Player, location: Location): Boolean {
-        if (SuperiorSkyblockAPI.getPlayer(player).hasBypassModeEnabled()) return true
+        if (SuperiorSkyblockAPI.getPlayer(player).hasBypassModeEnabled()) {
+            return true
+        }
         return SuperiorSkyblockAPI.getIslandAt(location)?.isMember(SuperiorSkyblockAPI.getPlayer(player)) ?: true
     }
 
     override fun canPlaceBlock(player: Player, block: Block): Boolean {
-        if (SuperiorSkyblockAPI.getPlayer(player).hasBypassModeEnabled()) return true
+        if (SuperiorSkyblockAPI.getPlayer(player).hasBypassModeEnabled()) {
+            return true
+        }
         return SuperiorSkyblockAPI.getPlayer(player).hasPermission(IslandPrivilege.getByName("Place"))
                 || SuperiorSkyblockAPI.getPlayer(player).hasPermission(IslandPrivilege.getByName("PLACE"))
     }
 
     override fun canInjure(player: Player, victim: LivingEntity): Boolean {
-        if (SuperiorSkyblockAPI.getPlayer(player).hasBypassModeEnabled()) return true
+        if (SuperiorSkyblockAPI.getPlayer(player).hasBypassModeEnabled()) {
+            return true
+        }
         return when (victim) {
             is Player -> SuperiorSkyblockAPI.getPlayer(player).canHit(SuperiorSkyblockAPI.getPlayer(victim)).equals(HitActionResult.SUCCESS)
             is Animals -> {

gradle.properties

@@ -1,2 +1,2 @@
-version = 6.13.7
+version = 6.13.8
 plugin-name = eco