Package net.neoforged.neoforge.common.world

Record Class BiomeModifiers.AddSpawnsBiomeModifier

java.lang.Object

java.lang.Record

net.neoforged.neoforge.common.world.BiomeModifiers.AddSpawnsBiomeModifier

Record Components:

biomes - Biomes to add mob spawns to.

spawners - List of Weighted SpawnerDatas specifying EntityType, weight, and pack size.

All Implemented Interfaces:

BiomeModifier

Enclosing class:

BiomeModifiers

public static record BiomeModifiers.AddSpawnsBiomeModifier(net.minecraft.core.HolderSet<net.minecraft.world.level.biome.Biome> biomes, net.minecraft.util.random.WeightedList<net.minecraft.world.level.biome.MobSpawnSettings.SpawnerData> spawners)
extends Record
implements BiomeModifier

Stock biome modifier that adds a mob spawn to a biome. Has the following json format:

 {
   "type": "neoforge:add_spawns", // Required
   "biomes": "#namespace:biome_tag", // Accepts a biome id, [list of biome ids], or #namespace:biome_tag
   "spawners":
   {
     "type": "namespace:entity_type", // Type of mob to spawn
     "weight": 100, // int, spawn weighting
     "minCount": 1, // int, minimum pack size
     "maxCount": 4, // int, maximum pack size
   }
 }
 

Optionally accepts a list of spawner objects instead of a single spawner:

 {
   "type": "neoforge:add_spawns", // Required
   "biomes": "#namespace:biome_tag", // Accepts a biome id, [list of biome ids], or #namespace:biome_tag
   "spawners":
   [
     {
       "type": "namespace:entity_type", // Type of mob to spawn
       "weight": 100, // int, spawn weighting
       "minCount": 1, // int, minimum pack size
       "maxCount": 4, // int, maximum pack size
     },
     {
       // additional spawner object
     }
   ]
 }
 

Nested Class Summary

Nested classes/interfaces inherited from interface net.neoforged.neoforge.common.world.BiomeModifier

BiomeModifier.Phase

Field Summary

Fields

Modifier and Type	Field	Description
private final net.minecraft.core.HolderSet<net.minecraft.world.level.biome.Biome>	biomes	The field for the biomes record component.
private final net.minecraft.util.random.WeightedList<net.minecraft.world.level.biome.MobSpawnSettings.SpawnerData>	spawners	The field for the spawners record component.

Fields inherited from interface net.neoforged.neoforge.common.world.BiomeModifier

DIRECT_CODEC, LIST_CODEC, REFERENCE_CODEC

Constructor Summary

Constructors

Constructor	Description
AddSpawnsBiomeModifier(net.minecraft.core.HolderSet<net.minecraft.world.level.biome.Biome> biomes, net.minecraft.util.random.WeightedList<net.minecraft.world.level.biome.MobSpawnSettings.SpawnerData> spawners)	Creates an instance of a AddSpawnsBiomeModifier record class.

Method Summary

Modifier and Type	Method	Description
net.minecraft.core.HolderSet<net.minecraft.world.level.biome.Biome>	biomes()	Returns the value of the biomes record component.
com.mojang.serialization.MapCodec<? extends BiomeModifier>	codec()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
void	modify(net.minecraft.core.Holder<net.minecraft.world.level.biome.Biome> biome, BiomeModifier.Phase phase, ModifiableBiomeInfo.BiomeInfo.Builder builder)	Modifies the information via the provided biome builder.
static BiomeModifiers.AddSpawnsBiomeModifier	singleSpawn(net.minecraft.core.HolderSet<net.minecraft.world.level.biome.Biome> biomes, net.minecraft.util.random.Weighted<net.minecraft.world.level.biome.MobSpawnSettings.SpawnerData> spawner)	Convenience method for using a single MobSpawnSettings.SpawnerDatas.
net.minecraft.util.random.WeightedList<net.minecraft.world.level.biome.MobSpawnSettings.SpawnerData>	spawners()	Returns the value of the spawners record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

biomes

private final net.minecraft.core.HolderSet<net.minecraft.world.level.biome.Biome> biomes

The field for the biomes record component.

spawners

private final net.minecraft.util.random.WeightedList<net.minecraft.world.level.biome.MobSpawnSettings.SpawnerData> spawners

The field for the spawners record component.

Constructor Details

AddSpawnsBiomeModifier

public AddSpawnsBiomeModifier(net.minecraft.core.HolderSet<net.minecraft.world.level.biome.Biome> biomes,
 net.minecraft.util.random.WeightedList<net.minecraft.world.level.biome.MobSpawnSettings.SpawnerData> spawners)

Creates an instance of a AddSpawnsBiomeModifier record class.

Parameters:

biomes - the value for the biomes record component

spawners - the value for the spawners record component

Method Details

singleSpawn

public static BiomeModifiers.AddSpawnsBiomeModifier singleSpawn(net.minecraft.core.HolderSet<net.minecraft.world.level.biome.Biome> biomes,
 net.minecraft.util.random.Weighted<net.minecraft.world.level.biome.MobSpawnSettings.SpawnerData> spawner)

Convenience method for using a single MobSpawnSettings.SpawnerDatas.

Parameters:

biomes - Biomes to add mob spawns to.

spawner - Weighted SpawnerData specifying EntityTYpe, weight, and pack size.

Returns:

AddSpawnsBiomeModifier that adds a single spawn entry to the specified biomes.

modify

public void modify(net.minecraft.core.Holder<net.minecraft.world.level.biome.Biome> biome,
 BiomeModifier.Phase phase,
 ModifiableBiomeInfo.BiomeInfo.Builder builder)

Description copied from interface: BiomeModifier

Modifies the information via the provided biome builder. Allows mob spawns and world-gen features to be added or removed, and climate and client effects to be modified.

Specified by:

modify in interface BiomeModifier

Parameters:

biome - the named biome being modified (with original data readable).

phase - biome modification phase. Biome modifiers apply in each phase in order of the enum constants.

builder - mutable biome info builder. Apply changes to this.

codec

public com.mojang.serialization.MapCodec<? extends BiomeModifier> codec()

Specified by:

codec in interface BiomeModifier

Returns:

the codec which serializes and deserializes this biome modifier

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

biomes

public net.minecraft.core.HolderSet<net.minecraft.world.level.biome.Biome> biomes()

Returns the value of the biomes record component.

Returns:

the value of the biomes record component

spawners

public net.minecraft.util.random.WeightedList<net.minecraft.world.level.biome.MobSpawnSettings.SpawnerData> spawners()

Returns the value of the spawners record component.

Returns:

the value of the spawners record component