Interface AquiferSettings

All Superinterfaces:

Wrapper

@NullMarked
@AsOf("4.0.0")
public interface AquiferSettings
extends Wrapper

The density functions used by Minecraft's optional aquifer system.

Since:

4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AquiferSettings.Builder	Builder for AquiferSettings.

Method Summary

Modifier and Type	Method	Description
DensityFunction	barrier()	The density function used to create barriers between neighboring aquifers.
static AquiferSettings.Builder	builder()	Creates a new aquifer settings builder.
static AquiferSettings	decode(Object minecraftAquiferSettings)	Reads Minecraft aquifer settings.
DensityFunction	exclusion()	The density function controlling areas excluded from aquifer generation.
DensityFunction	fluidLevelFloodedness()	The density function controlling how readily an area becomes flooded.
DensityFunction	fluidLevelSpread()	The density function controlling variation in aquifer fluid levels.
DensityFunction	lava()	The density function controlling where aquifers contain lava.
static AquiferSettings	of(DensityFunction barrier, DensityFunction fluidLevelFloodedness, DensityFunction fluidLevelSpread, DensityFunction lava, DensityFunction exclusion, DensityFunction surfaceLevel)	Creates aquifer settings.
DensityFunction	surfaceLevel()	The density function used to determine aquifer surface levels.
default AquiferSettings.Builder	toBuilder()	Converts these aquifer settings back into a builder.

Methods inherited from interface Wrapper

asHandle, toMinecraft, unwrap

Method Details

barrier

@AsOf("4.0.0")
DensityFunction barrier()

The density function used to create barriers between neighboring aquifers.

Returns:

the aquifer barrier density function

Since:

4.0.0

fluidLevelFloodedness

@AsOf("4.0.0")
DensityFunction fluidLevelFloodedness()

The density function controlling how readily an area becomes flooded.

Returns:

the fluid-level floodedness density function

Since:

4.0.0

fluidLevelSpread

@AsOf("4.0.0")
DensityFunction fluidLevelSpread()

The density function controlling variation in aquifer fluid levels.

Returns:

the fluid-level spread density function

Since:

4.0.0

lava

@AsOf("4.0.0")
DensityFunction lava()

The density function controlling where aquifers contain lava.

Returns:

the lava density function

Since:

4.0.0

exclusion

@AsOf("4.0.0")
DensityFunction exclusion()

The density function controlling areas excluded from aquifer generation.

Returns:

the aquifer exclusion density function

Since:

4.0.0

surfaceLevel

@AsOf("4.0.0")
DensityFunction surfaceLevel()

The density function used to determine aquifer surface levels.

Returns:

the aquifer surface-level density function

Since:

4.0.0

toBuilder

@AsOf("4.0.0")
default AquiferSettings.Builder toBuilder()

Converts these aquifer settings back into a builder.

Returns:

a builder containing these settings

Since:

4.0.0

of

@AsOf("4.0.0")
static AquiferSettings of(DensityFunction barrier,
 DensityFunction fluidLevelFloodedness,
 DensityFunction fluidLevelSpread,
 DensityFunction lava,
 DensityFunction exclusion,
 DensityFunction surfaceLevel)

Creates aquifer settings.

Parameters:

barrier - the barrier density function

fluidLevelFloodedness - the fluid-level floodedness density function

fluidLevelSpread - the fluid-level spread density function

lava - the lava density function

exclusion - the aquifer exclusion density function

surfaceLevel - the aquifer surface-level density function

Returns:

new aquifer settings

Since:

4.0.0

builder

@AsOf("4.0.0")
static AquiferSettings.Builder builder()

Creates a new aquifer settings builder.

Returns:

a new builder

Since:

4.0.0

decode

@AsOf("4.0.0")
static AquiferSettings decode(Object minecraftAquiferSettings)

Reads Minecraft aquifer settings.

Parameters:

minecraftAquiferSettings - the Minecraft aquifer settings to read

Returns:

the decoded aquifer settings

Since:

4.0.0