Package net.neoforged.neoforge.common.world

Class ModifiableBiomeInfo

java.lang.Object

net.neoforged.neoforge.common.world.ModifiableBiomeInfo

public class ModifiableBiomeInfo
extends Object

Holds lazy-evaluable modified biome info. Memoizers are not used because it's important to return null without evaluating the biome info if it's accessed outside of a server context.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ModifiableBiomeInfo.BiomeInfo	Record containing raw biome data.

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.slf4j.Logger	LOGGER
private @Nullable ModifiableBiomeInfo.BiomeInfo	modifiedBiomeInfo
private final ModifiableBiomeInfo.BiomeInfo	originalBiomeInfo

Constructor Summary

Constructors

Constructor	Description
ModifiableBiomeInfo(ModifiableBiomeInfo.BiomeInfo originalBiomeInfo)

Method Summary

Modifier and Type	Method	Description
boolean	applyBiomeModifiers(net.minecraft.core.Holder<net.minecraft.world.level.biome.Biome> biome, List<BiomeModifier> biomeModifiers, net.minecraft.core.RegistryAccess registryAccess)	Internal NeoForge method.
ModifiableBiomeInfo.BiomeInfo	get()	Returns The modified biome info if modified biome info has been generated, otherwise gets original biome info.
@Nullable ModifiableBiomeInfo.BiomeInfo	getModifiedBiomeInfo()	Returns Modified biome info; null if it hasn't been set yet.
ModifiableBiomeInfo.BiomeInfo	getOriginalBiomeInfo()	Returns The original biome info that the associated biome was created with.

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

originalBiomeInfo

private final ModifiableBiomeInfo.BiomeInfo originalBiomeInfo

modifiedBiomeInfo

@Nullable
private @Nullable ModifiableBiomeInfo.BiomeInfo modifiedBiomeInfo

Constructor Details

ModifiableBiomeInfo

public ModifiableBiomeInfo(ModifiableBiomeInfo.BiomeInfo originalBiomeInfo)

Parameters:

originalBiomeInfo - BiomeInfo representing the original state of a biome when the biome was constructed.

Method Details

get

public ModifiableBiomeInfo.BiomeInfo get()

Returns The modified biome info if modified biome info has been generated, otherwise gets original biome info.

Returns:

The modified biome info if modified biome info has been generated, otherwise gets original biome info

getOriginalBiomeInfo

public ModifiableBiomeInfo.BiomeInfo getOriginalBiomeInfo()

Returns The original biome info that the associated biome was created with.

Returns:

The original biome info that the associated biome was created with

getModifiedBiomeInfo

@Nullable
public @Nullable ModifiableBiomeInfo.BiomeInfo getModifiedBiomeInfo()

Returns Modified biome info; null if it hasn't been set yet.

Returns:

Modified biome info; null if it hasn't been set yet

applyBiomeModifiers

@Internal
public boolean applyBiomeModifiers(net.minecraft.core.Holder<net.minecraft.world.level.biome.Biome> biome,
 List<BiomeModifier> biomeModifiers,
 net.minecraft.core.RegistryAccess registryAccess)

Internal NeoForge method. Will do nothing if this modifier had already been applied. Creates and caches the modified biome info.

Parameters:

biome - named biome with original data.

biomeModifiers - biome modifiers to apply.

Returns:

whether the biome's network-synced data was modified