update WorldGen API

Author: Faithcaio

src/main/java/org/spongepowered/api/world/WorldType.java

@@ -39,7 +39,6 @@
 import org.spongepowered.api.service.context.ContextSource;
 import org.spongepowered.api.util.MinecraftDayTime;
 import org.spongepowered.api.util.annotation.CatalogedBy;
-import org.spongepowered.api.world.biome.BiomeSampler;
 import org.spongepowered.api.world.portal.PortalType;
 import org.spongepowered.api.world.portal.PortalTypes;
 import org.spongepowered.api.world.server.ServerLocation;

src/main/java/org/spongepowered/api/world/WorldTypeTemplate.java

@@ -30,7 +30,6 @@
 import org.spongepowered.api.util.CopyableBuilder;
 import org.spongepowered.api.util.MinecraftDayTime;
 import org.spongepowered.api.util.ResourceKeyedBuilder;
-import org.spongepowered.api.world.biome.BiomeSampler;
 
 import java.util.Optional;
 

src/main/java/org/spongepowered/api/world/biome/BiomeAttributes.java

@@ -25,39 +25,57 @@
 package org.spongepowered.api.world.biome;
 
 import org.spongepowered.api.Sponge;
+import org.spongepowered.api.util.Range;
 
+/**
+ * Attributes with which biomes are picked for during world generation.
+ */
 public interface BiomeAttributes {
 
-    static BiomeAttributes of(final float temperature, final float humidity, final float altitude, final float weirdness, final float offset) {
-        return Sponge.game().factoryProvider().provide(Factory.class).of(temperature, humidity, altitude, weirdness, offset);
+    static BiomeAttributes of(final float temperature, final float humidity, final float continentalness, final float erosion, final float depth, final float weirdness, final float offset) {
+        return Sponge.game().factoryProvider().provide(Factory.class).of(temperature, humidity, continentalness, erosion, depth, weirdness, offset);
     }
 
     /**
-     * Gets the temperature.
+     * The temperature range.
      *
      * <p>In Vanilla Minecraft, this is capped between {@code -2} to {@code 2}.</p>
      *
      * @return temperature
      */
-    float temperature();
+    Range<Float> temperature();
 
     /**
-     * Get the humidity.
+     * The humidity range.
      *
      * <p>In Vanilla Minecraft, this is capped between {@code -2} to {@code 2}.</p>
      *
      * @return humidity
      */
-    float humidity();
+    Range<Float> humidity();
 
     /**
-     * Gets the altitude.
+     * The continentalness.
+     * <p>Higher value when more inland. For low values oceans may generate.</p>
      *
-     * <p>In Vanilla Minecraft, this is capped between {@code -2} to {@code 2}.</p>
+     * @return continentalness
+     */
+    Range<Float> continentalness();
+
+    /**
+     * The erosion.
+     * <p>Higher values result in flatter areas, low values result in mountainous areas.</p>
+     *
+     * @return erosion
+     */
+    Range<Float> erosion();
+
+    /**
+     * The depth.
      *
-     * @return altitude
+     * @return the depth.
      */
-    float altitude();
+    Range<Float> depth();
 
     /**
      * Gets the weirdness.
@@ -66,10 +84,10 @@ static BiomeAttributes of(final float temperature, final float humidity, final f
      *
      * @return weirdness
      */
-    float weirdness();
+    Range<Float> weirdness();
 
     /**
-     * Gets the offset.
+     * The offset.
      *
      * <p>In Vanilla Minecraft, this is capped between {@code 0} to {@code 1}.</p>
      *
@@ -79,6 +97,6 @@ static BiomeAttributes of(final float temperature, final float humidity, final f
 
     interface Factory {
 
-        BiomeAttributes of(float temperature, float humidity, float altitude, float weirdness, float offset);
+        BiomeAttributes of(float temperature, float humidity, float continentalness, float erosion, float depth, float weirdness, float offset);
     }
 }

src/main/java/org/spongepowered/api/world/biome/BiomeSampler.java

@@ -33,60 +33,162 @@
 import java.util.Objects;
 import java.util.Set;
 
+/**
+ * Provides available Biomes for world generation.
+ */
 public interface BiomeProvider extends BiomeFinder {
 
-    static <T extends LayeredBiomeConfig> ConfigurableBiomeProvider<T> layered(final T config) {
-        return Sponge.game().factoryProvider().provide(Factory.class).layered(config);
-    }
-
-    static ConfigurableBiomeProvider<LayeredBiomeConfig> overworld() {
+    /**
+     * Returns the vanilla overworld biome provider.
+     *
+     * @return the vanilla overworld biome provider.
+     */
+    static ConfigurableBiomeProvider<MultiNoiseBiomeConfig> overworld() {
         return Sponge.game().factoryProvider().provide(Factory.class).overworld();
     }
 
+    /**
+     * Returns a multi-noise biome provider based on a {@link MultiNoiseBiomeConfig}.
+     * @param config the configuration
+     * @param <T> the configuration type
+     *
+     * @return the configured BiomeProvider
+     */
     static <T extends MultiNoiseBiomeConfig> ConfigurableBiomeProvider<T> multiNoise(final T config) {
         return Sponge.game().factoryProvider().provide(Factory.class).multiNoise(config);
     }
 
+    /**
+     * Returns the vanilla nether biome provider.
+     *
+     * @return the vanilla nether biome provider.
+     */
     static ConfigurableBiomeProvider<MultiNoiseBiomeConfig> nether() {
         return Sponge.game().factoryProvider().provide(Factory.class).nether();
     }
 
+    /**
+     * Returns a vanilla end-style biome provider based on a {@link EndStyleBiomeConfig}.
+     *
+     * @param config the configuration
+     * @param <T> the configuration type
+     *
+     * @return the configured BiomeProvider
+     */
     static <T extends EndStyleBiomeConfig> ConfigurableBiomeProvider<T> endStyle(final T config) {
         return Sponge.game().factoryProvider().provide(Factory.class).endStyle(config);
     }
 
+    /**
+     * Returns the vanilla end biome provider.
+     *
+     * @return the vanilla end biome provider.
+     */
     static ConfigurableBiomeProvider<EndStyleBiomeConfig> end() {
         return Sponge.game().factoryProvider().provide(Factory.class).end();
     }
 
+    /**
+     * Returns a checkerboard-style biome provider based on a {@link CheckerboardBiomeConfig}
+     *
+     * @param config the configuration
+     * @param <T> the configuration type
+     *
+     * @return the configured BiomeProvider
+     */
     static <T extends CheckerboardBiomeConfig> ConfigurableBiomeProvider<T> checkerboard(final T config) {
         return Sponge.game().factoryProvider().provide(Factory.class).checkerboard(config);
     }
 
+    /**
+     * Returns a fixed biome provider base on a single {@link Biome}
+     *
+     * @param biome the biome
+     *
+     * @return the configured BiomeProvider
+     */
     static BiomeProvider fixed(final RegistryReference<Biome> biome) {
         return Sponge.game().factoryProvider().provide(Factory.class).fixed(Objects.requireNonNull(biome, "biome"));
     }
 
+    /**
+     * The list of biomes possible.
+     *
+     * @return the list of biomes possible.
+     */
     List<Biome> choices();
 
+    /**
+     * The set of biomes within an area.
+     *
+     * @param x the center x coordinate
+     * @param y the center y coordinate
+     * @param z the center z coordinate
+     * @param size the square area radius
+     *
+     * @return the set of biomes.
+     */
     Set<Biome> within(int x, int y, int z, int size);
 
     interface Factory {
 
-        <T extends LayeredBiomeConfig> ConfigurableBiomeProvider<T> layered(T config);
-
-        ConfigurableBiomeProvider<LayeredBiomeConfig> overworld();
-
+        /**
+         * Returns the vanilla overworld biome provider.
+         *
+         * @return the vanilla overworld biome provider.
+         */
+        ConfigurableBiomeProvider<MultiNoiseBiomeConfig> overworld();
+
+        /**
+         * Returns a multi-noise biome provider based on a {@link MultiNoiseBiomeConfig}.
+         * @param config the configuration
+         * @param <T> the configuration type
+         *
+         * @return the configured BiomeProvider
+         */
         <T extends MultiNoiseBiomeConfig> ConfigurableBiomeProvider<T> multiNoise(T config);
 
+        /**
+         * Returns the vanilla nether biome provider.
+         *
+         * @return the vanilla nether biome provider.
+         */
         ConfigurableBiomeProvider<MultiNoiseBiomeConfig> nether();
 
+        /**
+         * Returns a vanilla end-style biome provider based on a {@link EndStyleBiomeConfig}.
+         *
+         * @param config the configuration
+         * @param <T> the configuration type
+         *
+         * @return the configured BiomeProvider
+         */
         <T extends EndStyleBiomeConfig> ConfigurableBiomeProvider<T> endStyle(T config);
 
+        /**
+         * Returns the vanilla end biome provider.
+         *
+         * @return the vanilla end biome provider.
+         */
         ConfigurableBiomeProvider<EndStyleBiomeConfig> end();
 
+        /**
+         * Returns a checkerboard-style biome provider based on a {@link CheckerboardBiomeConfig}
+         *
+         * @param config the configuration
+         * @param <T> the configuration type
+         *
+         * @return the configured BiomeProvider
+         */
         <T extends CheckerboardBiomeConfig> ConfigurableBiomeProvider<T> checkerboard(T config);
 
+        /**
+         * Returns a fixed biome provider base on a single {@link Biome}
+         *
+         * @param biome the biome
+         *
+         * @return the configured BiomeProvider
+         */
         BiomeProvider fixed(RegistryReference<Biome> biome);
     }
 }

src/main/java/org/spongepowered/api/world/biome/provider/BiomeProvider.java

@@ -29,6 +29,9 @@
 
 import java.util.List;
 
+/**
+ * Base Interface for configurations of {@link BiomeProvider}.
+ */
 public interface BiomeProviderConfig {
 
     List<RegistryReference<Biome>> biomes();

src/main/java/org/spongepowered/api/world/biome/provider/BiomeProviderConfig.java

@@ -22,27 +22,25 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  * THE SOFTWARE.
  */
-package org.spongepowered.api.world.biome;
+package org.spongepowered.api.world.biome.provider;
 
 import org.spongepowered.api.Sponge;
+import org.spongepowered.api.registry.RegistryReference;
+import org.spongepowered.api.world.biome.Biome;
 
-public final class BiomeSamplers {
-
-    // @formatter:off
-
-    // SORTFIELDS:ON
-
-    public static final BiomeSampler COLUMN_FUZZED = Sponge.game().factoryProvider().provide(BiomeSampler.Factory.class).columnFuzzed();
-
-    public static final BiomeSampler FUZZY = Sponge.game().factoryProvider().provide(BiomeSampler.Factory.class).fuzzy();
+/**
+ * The configuration for a {@link BiomeProvider} with a single {@link Biome}.
+ */
+public interface FixedBiomeConfig extends BiomeProviderConfig {
 
-    public static final BiomeSampler DEFAULT = Sponge.game().factoryProvider().provide(BiomeSampler.Factory.class).defaultFinder();
+    static FixedBiomeConfig of(RegistryReference<Biome> biome) {
+        return Sponge.game().factoryProvider().provide(Factory.class).biome(biome);
+    }
 
-    // SORTFIELDS:OFF
+    RegistryReference<Biome> biome();
 
-    // @formatter:on
+    interface Factory {
 
-    private BiomeSamplers() {
+        FixedBiomeConfig biome(RegistryReference<Biome> biome);
     }
-
 }