Class Biome.Builder

java.lang.Object

dev.wyck.biome.Biome.Builder

Direct Known Subclasses:

CustomBiome.Builder

Enclosing interface:

Biome

@AsOf("2.3.0")
public static class Biome.Builder
extends Object

Builder for Biome. Configures every property the base biome exposes.

Since:

2.3.0

Constructor Summary

Constructors

Constructor	Description
Builder()
Builder(Biome other)

Method Summary

Modifier and Type	Method	Description
<V> Biome.Builder	attribute(EnvironmentAttributeSupplier<V> attribute, @Nullable V value)
Biome.Builder	attribute(FriendlyColorSupplier attribute, @Nullable String hex)
Biome.Builder	attributes(EnvironmentAttributeMap attributeMap)	Sets the environment attributes of the biome.
Biome.Builder	biomeSpawner(@Nullable BiomeSpawner biomeSpawner)	Deprecated. Use attribute(EnvironmentAttributeSupplier, Object) with EnvironmentAttributes.NATURAL_MOB_SPAWNS
Biome	build()	Builds the biome.
Biome.Builder	climateSettings(ClimateSettings climateSettings)	Sets the climate settings of the biome.
Biome.Builder	generationSettings(@Nullable BiomeGenerationSettings generationSettings)	Sets the generation settings of the biome.
Biome	modify()
Biome	register()
Biome.Builder	resourceKey(ResourceKey resourceKey)	Sets the ResourceKey of the biome.
Biome.Builder	spawner(BiomeSpawner spawner)	Deprecated, for removal: This API element is subject to removal in a future version. Use attribute(EnvironmentAttributeSupplier, Object) with EnvironmentAttributes.NATURAL_MOB_SPAWNS
Biome.Builder	specialEffects(BiomeSpecialEffects specialEffects)	Sets the special effects of the biome.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

@AsOf("2.3.0")
public Builder()

Builder

@AsOf("2.3.0")
public Builder(Biome other)

Method Details

resourceKey

@AsOf("2.3.0")
public Biome.Builder resourceKey(ResourceKey resourceKey)

Sets the ResourceKey of the biome.

Parameters:

resourceKey - the ResourceKey of the biome

Returns:

this builder

climateSettings

@AsOf("3.0.0")
public Biome.Builder climateSettings(ClimateSettings climateSettings)

Sets the climate settings of the biome.

Parameters:

climateSettings - the climate settings of the biome

Returns:

this builder

Since:

3.0.0

specialEffects

@AsOf("3.0.0")
public Biome.Builder specialEffects(BiomeSpecialEffects specialEffects)

Sets the special effects of the biome.

Parameters:

specialEffects - the special effects of the biome

Returns:

this builder

Since:

3.0.0

attributes

@AsOf("3.0.0")
public Biome.Builder attributes(EnvironmentAttributeMap attributeMap)

Sets the environment attributes of the biome.

Parameters:

attributeMap - the environment attributes of the biome

Returns:

this builder

Since:

3.0.0

biomeSpawner

@Deprecated(since="4.0.0")
public Biome.Builder biomeSpawner(@Nullable BiomeSpawner biomeSpawner)

Deprecated.

Use attribute(EnvironmentAttributeSupplier, Object) with EnvironmentAttributes.NATURAL_MOB_SPAWNS

Sets the BiomeSpawner of the biome.

Parameters:

biomeSpawner - the BiomeSpawner of the biome, or null to remove it

Returns:

this builder

Since:

2.3.0

generationSettings

public Biome.Builder generationSettings(@Nullable BiomeGenerationSettings generationSettings)

Sets the generation settings of the biome.

Parameters:

generationSettings - the generation settings of the biome, or null to remove it

Returns:

this builder

Since:

2.3.0

attribute

@AsOf("3.0.0")
public <V> Biome.Builder attribute(EnvironmentAttributeSupplier<V> attribute,
 @Nullable V value)

attribute

@AsOf("3.0.0")
public Biome.Builder attribute(FriendlyColorSupplier attribute,
 @Nullable String hex)

spawner

@AsOf("3.0.0")
@Deprecated(since="4.0.0",
            forRemoval=true)
public Biome.Builder spawner(BiomeSpawner spawner)

Deprecated, for removal: This API element is subject to removal in a future version.

Use attribute(EnvironmentAttributeSupplier, Object) with EnvironmentAttributes.NATURAL_MOB_SPAWNS

Sets legacy biome spawn settings.

Parameters:

spawner - the legacy biome spawn settings

Returns:

this builder

Since:

3.0.0

build

@AsOf("2.3.0")
public Biome build()

Builds the biome.

Returns:

a new biome

Throws:

IllegalArgumentException - if the resource key is not set

Since:

2.3.0

register

@AsOf("3.0.0")
public Biome register()

modify

@AsOf("3.0.0")
public Biome modify()