Interface SurfaceRelativeThresholdFilter

All Superinterfaces:

PlacementFilter, PlacementModifier, Wrapper

@NullMarked
@AsOf("3.0.0")
public interface SurfaceRelativeThresholdFilter
extends PlacementFilter

Returns the current position if it lies within a range relative to the surface at that column. Otherwise returns empty.

Since:

3.0.0

See Also:

• Placement modifiers

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SurfaceRelativeThresholdFilter.Builder	builder()	Creates a new builder.
HeightmapType	heightmap()	The heightmap to measure the surface against.
int	maxInclusive()	The maximum relative height from the surface to the current position.
int	minInclusive()	The minimum relative height from the surface to the current position.
static SurfaceRelativeThresholdFilter	of(HeightmapType heightmap, int minInclusive, int maxInclusive)	Creates a new surface relative threshold filter.
default SurfaceRelativeThresholdFilter.Builder	toBuilder()	Converts this object back to a builder.

Methods inherited from interface Wrapper

asHandle, toMinecraft, unwrap

Method Details

heightmap

@AsOf("3.0.0")
HeightmapType heightmap()

The heightmap to measure the surface against.

Returns:

the heightmap type

Since:

3.0.0

minInclusive

@AsOf("3.0.0")
int minInclusive()

The minimum relative height from the surface to the current position.

Returns:

the minimum inclusive relative height

Since:

3.0.0

maxInclusive

@AsOf("3.0.0")
int maxInclusive()

The maximum relative height from the surface to the current position.

Returns:

the maximum inclusive relative height

Since:

3.0.0

toBuilder

@AsOf("3.0.0")
default SurfaceRelativeThresholdFilter.Builder toBuilder()

Converts this object back to a builder.

Returns:

a builder with the same values as this object

Since:

3.0.0

of

@AsOf("3.0.0")
static SurfaceRelativeThresholdFilter of(HeightmapType heightmap,
 int minInclusive,
 int maxInclusive)

Creates a new surface relative threshold filter.

Parameters:

heightmap - the heightmap to measure the surface against

minInclusive - the minimum relative height from the surface to the current position

maxInclusive - the maximum relative height from the surface to the current position

Returns:

a new surface relative threshold filter

Since:

3.0.0

builder

@AsOf("3.0.0")
static SurfaceRelativeThresholdFilter.Builder builder()

Creates a new builder.

Returns:

a new builder

Since:

3.0.0