Record Class BiomeModifiers.AddSpawnCostsBiomeModifier

java.lang.Object

java.lang.Record

net.neoforged.neoforge.common.world.BiomeModifiers.AddSpawnCostsBiomeModifier

Record Components:

biomes - Biomes to add spawn costs to.

entityTypes - EntityTypes to add spawn costs for.

spawnCost - MobSpawnCost to add for those entity types.

All Implemented Interfaces:

BiomeModifier

Enclosing class:

BiomeModifiers

public static record BiomeModifiers.AddSpawnCostsBiomeModifier(HolderSet<Biome> biomes, HolderSet<EntityType<?>> entityTypes, MobSpawnSettings.MobSpawnCost spawnCost)
extends Record
implements BiomeModifier

Stock biome modifier at adds spawn costs to a biome. Has the following json format:

{
  "type": "neoforge:add_spawn_costs", // Required
  "biomes": "#namespace:biome_tag", // Accepts a biome id, [list of biome ids], or #namespace:biome_tag
  "entity_types": #namespace:entitytype_tag, // Accepts an entity type, [list of entity types], or #namespace:entitytype_tag
  "spawn_cost": {
    "energy_budget": 1.0, // double
    "charge": 1.0 // double
  }
}

Nested Class Summary

Nested classes/interfaces inherited from interface BiomeModifier

BiomeModifier.Phase

Field Summary

Fields

Modifier and Type	Field	Description
private final HolderSet<Biome>	biomes	The field for the biomes record component.
private final HolderSet<EntityType<?>>	entityTypes	The field for the entityTypes record component.
private final MobSpawnSettings.MobSpawnCost	spawnCost	The field for the spawnCost record component.

Fields inherited from interface BiomeModifier

DIRECT_CODEC, LIST_CODEC, REFERENCE_CODEC

Constructor Summary

Constructors

Constructor	Description
AddSpawnCostsBiomeModifier(HolderSet<Biome> biomes, HolderSet<EntityType<?>> entityTypes, MobSpawnSettings.MobSpawnCost spawnCost)	Creates an instance of a AddSpawnCostsBiomeModifier record class.

Method Summary

Modifier and Type	Method	Description
HolderSet<Biome>	biomes()	Returns the value of the biomes record component.
com.mojang.serialization.MapCodec<? extends BiomeModifier>	codec()
HolderSet<EntityType<?>>	entityTypes()	Returns the value of the entityTypes record component.
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(Holder<Biome> biome, BiomeModifier.Phase phase, ModifiableBiomeInfo.BiomeInfo.Builder builder)	Modifies the information via the provided biome builder.
MobSpawnSettings.MobSpawnCost	spawnCost()	Returns the value of the spawnCost record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Field Details

biomes

private final HolderSet<Biome> biomes

The field for the biomes record component.

entityTypes

private final HolderSet<EntityType<?>> entityTypes

The field for the entityTypes record component.

spawnCost

private final MobSpawnSettings.MobSpawnCost spawnCost

The field for the spawnCost record component.

Constructor Details

AddSpawnCostsBiomeModifier

public AddSpawnCostsBiomeModifier(HolderSet<Biome> biomes,
 HolderSet<EntityType<?>> entityTypes,
 MobSpawnSettings.MobSpawnCost spawnCost)

Creates an instance of a AddSpawnCostsBiomeModifier record class.

Parameters:

biomes - the value for the biomes record component

entityTypes - the value for the entityTypes record component

spawnCost - the value for the spawnCost record component

Method Details

modify

public void modify(Holder<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 HolderSet<Biome> biomes()

Returns the value of the biomes record component.

Returns:

the value of the biomes record component

entityTypes

public HolderSet<EntityType<?>> entityTypes()

Returns the value of the entityTypes record component.

Returns:

the value of the entityTypes record component

spawnCost

public MobSpawnSettings.MobSpawnCost spawnCost()

Returns the value of the spawnCost record component.

Returns:

the value of the spawnCost record component