Interface StructureSettings

All Superinterfaces:

Wrapper

@NullMarked
@AsOf("3.4.0")
public interface StructureSettings
extends Wrapper

Structure placement settings.

Since:

3.4.0

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
TagSet<Biome>	biomes()	The biomes this structure may generate in, as an explicit set or a named biome tag.
static StructureSettings.Builder	builder(TagSet<Biome> biomes)	Creates a new builder.
static StructureSettings	decode(Object minecraftSettings)	Reads Minecraft structure settings.
static StructureSettings	of(TagSet<Biome> biomes)	Creates new structure settings with no spawn overrides, placed in Decoration.SURFACE_STRUCTURES without reshaping terrain.
static StructureSettings	of(TagSet<Biome> biomes, Map<MobCategory, StructureSpawnOverride> spawnOverrides, Decoration step, TerrainAdaptation terrainAdaptation)	Creates new structure settings.
Map<MobCategory, StructureSpawnOverride>	spawnOverrides()	The spawners this structure replaces inside its bounds, by category.
Decoration	step()	The generation step this structure is placed in.
TerrainAdaptation	terrainAdaptation()	How this structure reshapes the terrain it lands on.
default StructureSettings.Builder	toBuilder()	Converts this object back to a builder.

Methods inherited from interface Wrapper

asHandle, toMinecraft, unwrap

Method Details

biomes

@AsOf("3.4.0")
TagSet<Biome> biomes()

The biomes this structure may generate in, as an explicit set or a named biome tag.

Returns:

the biomes this structure may generate in

Since:

3.4.0

spawnOverrides

@AsOf("3.4.0")
Map<MobCategory, StructureSpawnOverride> spawnOverrides()

The spawners this structure replaces inside its bounds, by category.

Returns:

the spawn overrides, keyed by mob category

Since:

3.4.0

step

@AsOf("3.4.0")
Decoration step()

The generation step this structure is placed in.

Returns:

the generation step

Since:

3.4.0

terrainAdaptation

@AsOf("3.4.0")
TerrainAdaptation terrainAdaptation()

How this structure reshapes the terrain it lands on.

Returns:

the terrain adaptation

Since:

3.4.0

toBuilder

@AsOf("3.4.0")
default StructureSettings.Builder toBuilder()

Converts this object back to a builder.

Returns:

a builder with the same values as this object

Since:

3.4.0

of

@AsOf("3.4.0")
static StructureSettings of(TagSet<Biome> biomes,
 Map<MobCategory, StructureSpawnOverride> spawnOverrides,
 Decoration step,
 TerrainAdaptation terrainAdaptation)

Creates new structure settings.

Parameters:

biomes - the biomes the structure may generate in

spawnOverrides - the spawners the structure replaces inside its bounds

step - the generation step the structure is placed in

terrainAdaptation - how the structure reshapes the terrain it lands on

Returns:

new structure settings

Since:

3.4.0

of

@AsOf("3.4.0")
static StructureSettings of(TagSet<Biome> biomes)

Creates new structure settings with no spawn overrides, placed in Decoration.SURFACE_STRUCTURES without reshaping terrain.

Parameters:

biomes - the biomes the structure may generate in

Returns:

new structure settings

Since:

3.4.0

decode

@AsOf("3.4.0")
static StructureSettings decode(Object minecraftSettings)

Reads Minecraft structure settings.

Parameters:

minecraftSettings - the structure settings to read

Returns:

the decoded structure settings

Since:

3.4.0

builder

@AsOf("3.4.0")
static StructureSettings.Builder builder(TagSet<Biome> biomes)

Creates a new builder.

Parameters:

biomes - the biomes the structure may generate in

Returns:

a new builder

Since:

3.4.0