feat(enhanced-particle-api): improve the particle api

Author: Jsinco

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

@@ -6,8 +6,8 @@
 import me.outspending.biomesapi.annotations.AsOf;
 import me.outspending.biomesapi.packet.data.BlockReplacement;
 import me.outspending.biomesapi.registry.BiomeResourceKey;
-import me.outspending.biomesapi.renderer.ParticleRenderer;
 import me.outspending.biomesapi.wrapper.environment.attribute.WrappedEnvironmentAttributeMap;
+import me.outspending.biomesapi.wrapper.environment.particles.ParticleCatalog;
 import org.bukkit.Color;
 import org.bukkit.NamespacedKey;
 import org.bukkit.block.Biome;
@@ -149,9 +149,23 @@ public interface CustomBiome {
      *
      * @return the ParticleRenderer of the CustomBiome
      * @since 0.0.1
+     * @deprecated use {@link #getParticleCatalog()} instead.
      */
     @AsOf("0.0.1")
-    ParticleRenderer getParticleRenderer();
+    @Deprecated(forRemoval = true, since = "1.1.0")
+    @SuppressWarnings("removal")
+    default me.outspending.biomesapi.renderer.ParticleRenderer getParticleRenderer() {
+        throw new UnsupportedOperationException("Use getParticleCatalog() instead.");
+    }
+
+    /**
+     * Returns the ParticleRenderer of the CustomBiome.
+     *
+     * @return the ParticleRenderer of the CustomBiome
+     * @since 1.1.0
+     */
+    @AsOf("1.1.0")
+    ParticleCatalog getParticleCatalog();
 
     /**
      * Returns the BlockReplacements of the CustomBiome.
@@ -248,10 +262,24 @@ public interface CustomBiome {
      * Sets the ParticleRenderer of the CustomBiome.
      *
      * @param particleRenderer the ParticleRenderer of the CustomBiome
-     * @since 0.0.5
+     * @since 0.0.1
+     * @deprecated use {@link #setParticleCatalog(ParticleCatalog)} instead.
      */
-    @AsOf("0.0.5")
-    void setParticleRenderer(@NotNull ParticleRenderer particleRenderer);
+    @AsOf("0.0.1")
+    @Deprecated(forRemoval = true, since = "1.1.0")
+    @SuppressWarnings("removal")
+    default void setParticleRenderer(@NotNull me.outspending.biomesapi.renderer.ParticleRenderer particleRenderer) {
+        setParticleCatalog(ParticleCatalog.fromParticleRenderer(particleRenderer));
+    }
+
+    /**
+     * Sets the ParticleRenderer of the CustomBiome.
+     *
+     * @param particleCatalog the ParticleRenderer of the CustomBiome
+     * @since 1.1.0
+     */
+    @AsOf("1.1.0")
+    void setParticleCatalog(@NotNull ParticleCatalog particleCatalog);
 
     /**
      * Sets the BlockReplacements of the CustomBiome.
@@ -336,7 +364,7 @@ class Builder {
         private @Nullable Integer dryFoliageColor = -1;
 
         private GrassColorModifier grassColorModifier = GrassColorModifier.NONE;
-        private ParticleRenderer particleRenderer = ParticleRenderer.EMPTY;
+        private ParticleCatalog particleCatalog = ParticleCatalog.EMPTY;
         private BlockReplacement[] blockReplacements = new BlockReplacement[0];
         private WrappedEnvironmentAttributeMap environmentAttributeMap = WrappedEnvironmentAttributeMap.EMPTY;
 
@@ -394,7 +422,7 @@ public Builder(@NotNull CustomBiome biome) {
             this.grassColor = biome.getGrassColor();
             this.dryFoliageColor = biome.getDryFoliageColor();
             this.grassColorModifier = biome.getGrassColorModifier();
-            this.particleRenderer = biome.getParticleRenderer();
+            this.particleCatalog = biome.getParticleCatalog();
             this.blockReplacements = biome.getBlockReplacements();
             this.environmentAttributeMap = biome.getEnvironmentAttributeMap();
         }
@@ -612,12 +640,28 @@ public Builder(@NotNull CustomBiome biome) {
          * This method sets the particle renderer property of the CustomBiome.
          *
          * @param particleRenderer The particle renderer of the custom biome.
-         * @version 0.0.1
+         * @since 0.0.1
          * @return The Builder object, for chaining method calls.
+         * @deprecated use {@link #particleCatalog(ParticleCatalog)} instead.
          */
         @AsOf("0.0.1")
-        public @NotNull Builder particleRenderer(@NotNull ParticleRenderer particleRenderer) {
-            this.particleRenderer = particleRenderer;
+        @Deprecated(forRemoval = true, since = "1.1.0")
+        @SuppressWarnings("removal")
+        public @NotNull Builder particleRenderer(@NotNull me.outspending.biomesapi.renderer.ParticleRenderer particleRenderer) {
+            this.particleCatalog = ParticleCatalog.fromParticleRenderer(particleRenderer);
+            return this;
+        }
+
+        /**
+         * This method sets the particle catalog property of the CustomBiome.
+         *
+         * @param particleCatalog The particle catalog of the custom biome.
+         * @since 1.1.0
+         * @return The Builder object, for chaining method calls.
+         */
+        @AsOf("1.1.0")
+        public @NotNull Builder particleCatalog(@NotNull ParticleCatalog particleCatalog) {
+            this.particleCatalog = particleCatalog;
             return this;
         }
 
@@ -671,7 +715,7 @@ public Builder(@NotNull CustomBiome biome) {
                     grassColor,
                     dryFoliageColor,
                     grassColorModifier,
-                    particleRenderer,
+                    particleCatalog,
                     blockReplacements,
                     environmentAttributeMap
             );

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

@@ -8,21 +8,25 @@
 import me.outspending.biomesapi.packet.data.BlockReplacement;
 import me.outspending.biomesapi.registry.BiomeRegistry;
 import me.outspending.biomesapi.registry.BiomeResourceKey;
-import me.outspending.biomesapi.renderer.ParticleRenderer;
 import me.outspending.biomesapi.wrapper.environment.attribute.WrappedEnvironmentAttributeMap;
+import me.outspending.biomesapi.wrapper.environment.particles.ParticleCatalog;
 import net.minecraft.resources.Identifier;
 import org.bukkit.NamespacedKey;
 import org.bukkit.block.Biome;
+import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+import java.util.Objects;
+
 /**
  * This class represents a custom biome implementation.
  *
  * @author Outspending
  * @version 1.1.0
  * @since 0.0.2
  */
+@ApiStatus.Internal
 @AsOf("1.1.0")
 public final class CustomBiomeImpl implements CustomBiome {
 
@@ -43,7 +47,7 @@ public final class CustomBiomeImpl implements CustomBiome {
 
     // Optional Settings
     private GrassColorModifier grassColorModifier = GrassColorModifier.NONE;
-    private ParticleRenderer particleRenderer = ParticleRenderer.EMPTY;
+    private ParticleCatalog particleCatalog = ParticleCatalog.EMPTY;
     private BlockReplacement[] blockReplacements = new BlockReplacement[0];
 
     private WrappedEnvironmentAttributeMap environmentAttributeMap = WrappedEnvironmentAttributeMap.EMPTY;
@@ -58,11 +62,11 @@ public CustomBiomeImpl(
             @Nullable Integer waterFogColor,
             @Nullable Integer skyColor,
 
-            @NotNull ParticleRenderer particleRenderer
+            @NotNull ParticleCatalog particleCatalog
     ) {
         this.resourceKey = resourceKey;
         this.settings = settings;
-        this.particleRenderer = particleRenderer;
+        this.particleCatalog = particleCatalog;
 
         this.fogColor = fogColor;
         this.waterColor = waterColor;
@@ -83,9 +87,9 @@ public CustomBiomeImpl(
             @Nullable Integer foliageColor,
             @Nullable Integer grassColor,
 
-            @NotNull ParticleRenderer particleRenderer
+            @NotNull ParticleCatalog particleCatalog
     ) {
-        this(resourceKey, settings, fogColor, waterColor, waterFogColor, skyColor, particleRenderer);
+        this(resourceKey, settings, fogColor, waterColor, waterFogColor, skyColor, particleCatalog);
         this.foliageColor = foliageColor;
         this.grassColor = grassColor;
         this.blockReplacements = new BlockReplacement[0];
@@ -105,11 +109,11 @@ public CustomBiomeImpl(
             @Nullable Integer dryFoliageColor,
 
             @NotNull GrassColorModifier grassColorModifier,
-            @NotNull ParticleRenderer particleRenderer,
+            @NotNull ParticleCatalog particleCatalog,
             @NotNull BlockReplacement[] blockReplacements,
             @NotNull WrappedEnvironmentAttributeMap environmentAttributeMap
     ) {
-        this(resourceKey, settings, fogColor, waterColor, waterFogColor, skyColor, particleRenderer);
+        this(resourceKey, settings, fogColor, waterColor, waterFogColor, skyColor, particleCatalog);
         this.foliageColor = foliageColor;
         this.grassColor = grassColor;
         this.dryFoliageColor = dryFoliageColor;
@@ -179,8 +183,8 @@ public GrassColorModifier getGrassColorModifier() {
     }
 
     @Override
-    public @NotNull ParticleRenderer getParticleRenderer() {
-        return particleRenderer;
+    public @NotNull ParticleCatalog getParticleCatalog() {
+        return particleCatalog;
     }
 
     @Override
@@ -233,8 +237,8 @@ public void setGrassColorModifier(@NotNull GrassColorModifier grassColorModifier
     }
 
     @Override
-    public void setParticleRenderer(@NotNull ParticleRenderer particleRenderer) {
-        this.particleRenderer = particleRenderer;
+    public void setParticleCatalog(@NotNull ParticleCatalog particleCatalog) {
+        this.particleCatalog = particleCatalog;
     }
 
     @Override
@@ -262,20 +266,20 @@ public void modify() {
         BiomeRegistry.newRegistry().modify(this);
     }
 
-    @Override
+    @Override // TODO: cleanup
     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 (!Objects.equals(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.dryFoliageColor != otherBiome.getDryFoliageColor()) return false;
+        if (!Objects.equals(this.waterFogColor, otherBiome.getWaterFogColor())) return false;
+        if (!Objects.equals(this.skyColor, otherBiome.getSkyColor())) return false;
+        if (!Objects.equals(this.foliageColor, otherBiome.getFoliageColor())) return false;
+        if (!Objects.equals(this.grassColor, otherBiome.getGrassColor())) return false;
+        if (!Objects.equals(this.dryFoliageColor, otherBiome.getDryFoliageColor())) return false;
         if (!this.grassColorModifier.equals(otherBiome.getGrassColorModifier())) return false;
-        if (!this.particleRenderer.equals(otherBiome.getParticleRenderer())) return false;
+        if (!this.particleCatalog.equals(otherBiome.getParticleCatalog())) 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])) {

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

@@ -9,10 +9,10 @@
 import me.outspending.biomesapi.biome.CustomBiome;
 import me.outspending.biomesapi.nms.NMS;
 import me.outspending.biomesapi.nms.NMSHandler;
-import me.outspending.biomesapi.registry.handlers.ParticleRendererHandler;
+import me.outspending.biomesapi.registry.handlers.ParticleCatalogHandler;
 import me.outspending.biomesapi.registry.handlers.SpecialEffectsHandler;
-import me.outspending.biomesapi.renderer.ParticleRenderer;
 import me.outspending.biomesapi.wrapper.environment.attribute.WrappedEnvironmentAttributeMap;
+import me.outspending.biomesapi.wrapper.environment.particles.ParticleCatalog;
 import net.minecraft.core.Registry;
 import net.minecraft.resources.Identifier;
 import net.minecraft.world.attribute.EnvironmentAttributeMap;
@@ -39,10 +39,9 @@
 public class CustomBiomeRegistry implements BiomeRegistry {
 
     private static final SpecialEffectsHandler SPECIAL_EFFECTS_HANDLER = new SpecialEffectsHandler();
-    private static final ParticleRendererHandler RENDERER_HANDLER = new ParticleRendererHandler();
+    private static final ParticleCatalogHandler PARTICLE_CATALOG_HANDLER = new ParticleCatalogHandler();
     private static final AttributeMapHandler ATTRIBUTE_MAP_HANDLER = new AttributeMapHandler();
 
-    //private static final String MINECRAFT_NAMESPACE = "minecraft";
 
     /**
      * This method registers a custom biome to a Minecraft server.
@@ -59,7 +58,6 @@ public class CustomBiomeRegistry implements BiomeRegistry {
     @SuppressWarnings("unchecked")
     public void register(@NotNull CustomBiome biome) {
         Preconditions.checkNotNull(biome, "biome cannot be null");
-        //Preconditions.checkArgument(!biome.toNamespacedKey().namespace().equals(MINECRAFT_NAMESPACE), "Illegal namespace: %s", MINECRAFT_NAMESPACE);
 
         BiomeLock.unlock(() -> {
 
@@ -95,8 +93,8 @@ public void register(@NotNull CustomBiome biome) {
                 BiomeSpecialEffects effects = SPECIAL_EFFECTS_HANDLER.build(biome);
                 SPECIAL_EFFECTS_HANDLER.handle(effects, biomeBuilder);
 
-                ParticleRenderer particleRenderer = biome.getParticleRenderer();
-                RENDERER_HANDLER.handle(particleRenderer, biomeBuilder);
+                ParticleCatalog particleCatalog = biome.getParticleCatalog();
+                PARTICLE_CATALOG_HANDLER.handle(particleCatalog, biomeBuilder);
 
                 WrappedEnvironmentAttributeMap wrappedAttributeMap = biome.getEnvironmentAttributeMap();
                 ATTRIBUTE_MAP_HANDLER.handle(wrappedAttributeMap, biomeBuilder);
@@ -143,8 +141,8 @@ public void modify(@NotNull CustomBiome customBiome) {
 
         // Rebuild biome components
         Biome.ClimateSettings climateSettings = new Biome.ClimateSettings(settings.hasPrecipitation(), settings.temperature(), settings.modifier().getModifier(), settings.downfall());
-        ParticleRenderer particleRenderer = customBiome.getParticleRenderer();
-        List<net.minecraft.world.attribute.AmbientParticle> particles = RENDERER_HANDLER.create(particleRenderer);
+        ParticleCatalog particleCatalog = customBiome.getParticleCatalog();
+        List<net.minecraft.world.attribute.AmbientParticle> particles = PARTICLE_CATALOG_HANDLER.create(particleCatalog);
 
 
         EnvironmentAttributeMap.Builder environmentAttributeMapBuilder = EnvironmentAttributeMap.builder()

main/src/main/java/me/outspending/biomesapi/registry/handlers/AttributeMapHandler.java

@@ -14,7 +14,6 @@ public class AttributeMapHandler implements BuilderHandler<Biome.BiomeBuilder, W
     public void handle(WrappedEnvironmentAttributeMap value, Biome.@NotNull BiomeBuilder key) {
         if (value == null || value.empty()) return;
 
-
         value.applyToBiomeBuilder(key);
     }
 

main/src/main/java/me/outspending/biomesapi/registry/handlers/ParticleCatalogHandler.java

@@ -0,0 +1,37 @@
+package me.outspending.biomesapi.registry.handlers;
+
+import me.outspending.biomesapi.biome.CustomBiome;
+import me.outspending.biomesapi.registry.BuilderHandler;
+import me.outspending.biomesapi.wrapper.environment.particles.ParticleCatalog;
+import net.minecraft.world.attribute.AmbientParticle;
+import net.minecraft.world.attribute.EnvironmentAttributes;
+import net.minecraft.world.level.biome.Biome;
+import org.jetbrains.annotations.Contract;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.List;
+
+public class ParticleCatalogHandler implements BuilderHandler<Biome.BiomeBuilder, ParticleCatalog> {
+
+    @Override
+    public void handle(ParticleCatalog value, @NotNull Biome.BiomeBuilder key) {
+        if (value == null) return;
+
+        List<AmbientParticle> minecraftAmbientParticles = create(value);
+
+        key.setAttribute(EnvironmentAttributes.AMBIENT_PARTICLES, minecraftAmbientParticles);
+    }
+
+    @Contract("null -> null")
+    public List<net.minecraft.world.attribute.AmbientParticle> create(ParticleCatalog value) {
+        if (value == null) return null;
+
+        return value.delegateParticles();
+    }
+
+    @Override
+    public @Nullable ParticleCatalog build(@NotNull CustomBiome biome) {
+        return null;
+    }
+}