API methods CustomBiome#modify, CustomBiome#isSimilar

Author: Jsinco

build.gradle.kts

@@ -12,7 +12,7 @@ allprojects {
     apply(plugin = "com.gradleup.shadow")
 
     group = "me.outspending.biomesapi"
-    version = "0.0.16"
+    version = "0.0.17"
 
     tasks.withType<JavaCompile> {
         options.encoding = "UTF-8"

main/src/main/java/me/outspending/biomesapi/biome/CustomBiome.java

@@ -15,11 +15,11 @@
  * This interface represents a custom biome in the BiomesAPI.
  * It provides methods to retrieve and modify the properties of the custom biome.
  *
- * @version 0.0.6
+ * @version 0.0.17
  * @since 0.0.1
  * @author Outspending
  */
-@AsOf("0.0.6")
+@AsOf("0.0.17")
 public interface CustomBiome {
 
     /**
@@ -230,6 +230,30 @@ public interface CustomBiome {
     @AsOf("0.0.2")
     void register();
 
+
+    /**
+     * Modifies the existing biome in the biome registry with the properties of this CustomBiome.
+     *
+     * @throws IllegalArgumentException if the biome does not already exist in the registry.
+     * @apiNote This method can only change the properties of an existing biome on the <b>server</b>.
+     * Clients which have already received the biome will not see any changes until they enter the reconfiguration phase
+     * (e.g., by rejoining the server.)
+     * @since 0.0.17
+     */
+    @AsOf("0.0.17")
+    void modify();
+
+    /**
+     * Compares this CustomBiome to another CustomBiome to determine if they are similar.
+     * Two CustomBiomes are considered similar if they have the same properties.
+     *
+     * @param otherBiome The other CustomBiome to compare to.
+     * @return true if the CustomBiomes are similar, false otherwise.
+     * @since 0.0.17
+     */
+    @AsOf("0.0.17")
+    boolean isSimilar(@NotNull CustomBiome otherBiome);
+
     /**
      * This class is used to create a new CustomBiome object.
      * It provides methods to set the properties of the CustomBiome.

main/src/main/java/me/outspending/biomesapi/biome/CustomBiomeImpl.java

@@ -216,4 +216,29 @@ public void register() {
         BiomeRegistry.newRegistry().register(this);
     }
 
+    @Override
+    public void modify() {
+        BiomeRegistry.newRegistry().modify(this);
+    }
+
+    @Override
+    public boolean isSimilar(@NotNull CustomBiome otherBiome) {
+        if (this == otherBiome) return true;
+        if (!this.resourceKey.equals(otherBiome.getResourceKey())) return false;
+        if (!this.settings.equals(otherBiome.getSettings())) return false;
+        if (this.fogColor != otherBiome.getFogColor()) return false;
+        if (this.waterColor != otherBiome.getWaterColor()) return false;
+        if (this.waterFogColor != otherBiome.getWaterFogColor()) return false;
+        if (this.skyColor != otherBiome.getSkyColor()) return false;
+        if (this.foliageColor != otherBiome.getFoliageColor()) return false;
+        if (this.grassColor != otherBiome.getGrassColor()) return false;
+        if (!this.particleRenderer.equals(otherBiome.getParticleRenderer())) return false;
+        if (this.blockReplacements.length != otherBiome.getBlockReplacements().length) return false;
+        for (int i = 0; i < this.blockReplacements.length; i++) {
+            if (!this.blockReplacements[i].equals(otherBiome.getBlockReplacements()[i])) {
+                return false;
+            }
+        }
+        return true;
+    }
 }

main/src/main/java/me/outspending/biomesapi/registry/BiomeRegistry.java

@@ -45,6 +45,7 @@ static BiomeRegistry newRegistry() {
      * Another biome must already exist with the same ResourceKey.
      * It takes a CustomBiome object as an argument.
      *
+     * @throws IllegalArgumentException if the biome does not already exist in the registry.
      * @apiNote This method can only change the properties of an existing biome on the <b>server</b>.
      * Clients which have already received the biome will not see any changes until they enter the reconfiguration phase
      * (e.g., by rejoining the server.)

main/src/main/java/me/outspending/biomesapi/renderer/ParticleRenderer.java

@@ -71,6 +71,19 @@ public record ParticleRenderer(@NotNull Map<@NotNull AmbientParticle, @NotNull F
     }
 
 
+    @Override
+    public boolean equals(Object obj) {
+        if (this == obj) return true;
+        if (obj == null || getClass() != obj.getClass()) return false;
+        ParticleRenderer that = (ParticleRenderer) obj;
+        return ambientParticles.equals(that.ambientParticles);
+    }
+
+    @Override
+    public int hashCode() {
+        return ambientParticles.hashCode();
+    }
+
     /**
      * Builder class for constructing ParticleRenderer instances.
      *