Interface StructurePlacement

All Superinterfaces:

Wrapper

All Known Subinterfaces:

ConcentricRingsPlacement, RandomSpreadPlacement

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

How a StructureSet spreads its structures across a dimension.

Since:

3.4.0

See Also:

• RandomSpreadPlacement
• ConcentricRingsPlacement
• Structure set

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	StructurePlacement.ExclusionZone	Keeps a placement away from chunks where another structure set already placed.

Method Summary

Modifier and Type	Method	Description
static StructurePlacement	decode(Object minecraftPlacement)	Reads a Minecraft structure placement.
Optional<StructurePlacement.ExclusionZone>	exclusionZone()	The zone around another structure set this placement avoids.
float	frequency()	The fraction of eligible chunks that actually receive the structure, from 0 to 1.
FrequencyReduction	frequencyReduction()	The reducer applied to frequency().
BlockVector	locateOffset()	The offset applied to a located position, used by /locate structure.
int	salt()	The salt mixed into the placement's random seed.

Methods inherited from interface Wrapper

asHandle, toMinecraft, unwrap

Method Details

locateOffset

@AsOf("3.4.0")
BlockVector locateOffset()

The offset applied to a located position, used by /locate structure.

Returns:

the locate offset

Since:

3.4.0

frequencyReduction

@AsOf("3.4.0")
FrequencyReduction frequencyReduction()

The reducer applied to frequency().

Returns:

the frequency reduction method

Since:

3.4.0

frequency

@AsOf("3.4.0")
float frequency()

The fraction of eligible chunks that actually receive the structure, from 0 to 1.

Returns:

the placement frequency

Since:

3.4.0

salt

@AsOf("3.4.0")
int salt()

The salt mixed into the placement's random seed. Two sets sharing a salt place in the same chunks.

Returns:

the placement salt

Since:

3.4.0

exclusionZone

@AsOf("3.4.0")
Optional<StructurePlacement.ExclusionZone> exclusionZone()

The zone around another structure set this placement avoids.

Returns:

the exclusion zone, if present

Since:

3.4.0

decode

@AsOf("3.4.0")
static StructurePlacement decode(Object minecraftPlacement)

Reads a Minecraft structure placement.

Parameters:

minecraftPlacement - the structure placement to read

Returns:

the decoded structure placement

Since:

3.4.0