Interface YAboveConditionSource

All Superinterfaces:

ConditionSource, SurfaceRule, Wrapper

@NullMarked
@AsOf("3.0.0")
public interface YAboveConditionSource
extends ConditionSource

Checks if the current position is above a specified height (exclusive).

Since:

3.0.0

See Also:

• Surface rule (surface conditions)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
boolean	addStoneDepth()	If true, adds the distance to the surface above to the offset.
VerticalAnchor	anchor()	The vertical anchor to compare the height with.
static YAboveConditionSource.Builder	builder()	Creates a new builder.
static YAboveConditionSource	of(VerticalAnchor anchor, int surfaceDepthMultiplier, boolean addStoneDepth)	Creates a new y above condition source.
int	surfaceDepthMultiplier()	How much the check is affected by the surface depth, between -20 and 20.
default YAboveConditionSource.Builder	toBuilder()	Converts this object back to a builder.

Methods inherited from interface ConditionSource

not, then

Methods inherited from interface Wrapper

asHandle, toMinecraft, unwrap

Method Details

anchor

@AsOf("3.0.0")
VerticalAnchor anchor()

The vertical anchor to compare the height with.

Returns:

the anchor

Since:

3.0.0

surfaceDepthMultiplier

@AsOf("3.0.0")
int surfaceDepthMultiplier()

How much the check is affected by the surface depth, between -20 and 20.

Returns:

the surface depth multiplier

Since:

3.0.0

addStoneDepth

@AsOf("3.0.0")
boolean addStoneDepth()

If true, adds the distance to the surface above to the offset.

Returns:

whether the stone depth is added

Since:

3.0.0

toBuilder

@AsOf("3.0.0")
default YAboveConditionSource.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 YAboveConditionSource of(VerticalAnchor anchor,
 int surfaceDepthMultiplier,
 boolean addStoneDepth)

Creates a new y above condition source.

Parameters:

anchor - the vertical anchor to compare the height with

surfaceDepthMultiplier - how much the check is affected by the surface depth

addStoneDepth - whether the distance to the surface above is added to the offset

Returns:

the y above condition source

Since:

3.0.0

builder

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

Creates a new builder.

Returns:

a new builder

Since:

3.0.0