Interface BlockPredicate

All Superinterfaces:

Wrapper

All Known Subinterfaces:

AllOfPredicate, AnyOfPredicate, CombiningPredicate, HasSturdyFacePredicate, InsideWorldBoundsPredicate, MatchingBiomesPredicate, MatchingBlocksPredicate, MatchingBlockTagPredicate, MatchingFluidsPredicate, NotPredicate, ReplaceablePredicate, SolidPredicate, TrueBlockPredicate, WouldSurvivePredicate

@NullMarked
@AsOf("2.3.0")
public interface BlockPredicate
extends Wrapper

A block predicate is a test for the state of a block at a given position in the world. They are used by placement modifiers in placed features and various configured features.

Since:

2.3.0

See Also:

• Block predicate

Method Summary

Modifier and Type	Method	Description
static AllOfPredicate.Builder	allOf()	Starts building an AllOfPredicate, which matches only when every child predicate matches.
static TrueBlockPredicate	alwaysTrue()	Returns the TrueBlockPredicate singleton, which always matches regardless of the block.
static AnyOfPredicate.Builder	anyOf()	Starts building an AnyOfPredicate, which matches when at least one child predicate matches.
static BlockPredicate	decode(Object minecraftPredicate)	Reads a Minecraft block predicate into a wrapper.
static HasSturdyFacePredicate.Builder	hasSturdyFace()	Starts building a HasSturdyFacePredicate, which checks that the block at an offset has a full supporting surface on a given face.
static InsideWorldBoundsPredicate.Builder	insideWorldBounds()	Starts building an InsideWorldBoundsPredicate, which checks that the position (with offset) is within the world's height limits.
static MatchingBiomesPredicate.Builder	matchingBiomes()	Starts building a MatchingBiomesPredicate, which checks that the biome at the block's position is one of the specified biomes.
static MatchingBlocksPredicate.Builder	matchingBlocks()	Starts building a MatchingBlocksPredicate, which checks that the block at an offset is one of the specified blocks.
static MatchingBlockTagPredicate.Builder	matchingBlockTag()	Starts building a MatchingBlockTagPredicate, which checks that the block at an offset is in the given block tag.
static MatchingBlockTagPredicate	matchingBlockTag(ResourceKey tag)	Creates a MatchingBlockTagPredicate that matches the block at the given offset.
static MatchingBlockTagPredicate	matchingBlockTag(Tag<Material> tag)	Creates a MatchingBlockTagPredicate that matches the block at the given offset.
static MatchingFluidsPredicate.Builder	matchingFluids()	Starts building a MatchingFluidsPredicate, which checks that the fluid at an offset is one of the specified fluids.
default NotPredicate	not()	Negates this predicate.
static NotPredicate	not(BlockPredicate predicate)	Creates a NotPredicate that inverts the given predicate.
static ReplaceablePredicate.Builder	replaceable()	Starts building a ReplaceablePredicate, which checks that the block at an offset can be replaced by placing blocks.
static SolidPredicate.Builder	solid()	Deprecated. Deprecated in Minecraft in favor of hasSturdyFace().
static WouldSurvivePredicate.Builder	wouldSurvive()	Starts building a WouldSurvivePredicate, which checks that a block state would be a valid placement at the given offset.

Methods inherited from interface Wrapper

asHandle, toMinecraft, unwrap

Method Details

not

@AsOf("3.0.0")
default NotPredicate not()

Negates this predicate.

Returns:

the negated predicate

Since:

3.0.0

allOf

@AsOf("3.0.0")
static AllOfPredicate.Builder allOf()

Starts building an AllOfPredicate, which matches only when every child predicate matches.

Returns:

a new AllOfPredicate.Builder

Since:

3.0.0

See Also:

• AllOfPredicate

anyOf

@AsOf("3.0.0")
static AnyOfPredicate.Builder anyOf()

Starts building an AnyOfPredicate, which matches when at least one child predicate matches.

Returns:

a new AnyOfPredicate.Builder

Since:

3.0.0

See Also:

• AnyOfPredicate

hasSturdyFace

@AsOf("3.0.0")
static HasSturdyFacePredicate.Builder hasSturdyFace()

Starts building a HasSturdyFacePredicate, which checks that the block at an offset has a full supporting surface on a given face.

Returns:

a new HasSturdyFacePredicate.Builder

Since:

3.0.0

See Also:

• HasSturdyFacePredicate

insideWorldBounds

@AsOf("3.0.0")
static InsideWorldBoundsPredicate.Builder insideWorldBounds()

Starts building an InsideWorldBoundsPredicate, which checks that the position (with offset) is within the world's height limits.

Returns:

a new InsideWorldBoundsPredicate.Builder

Since:

3.0.0

See Also:

• InsideWorldBoundsPredicate

matchingBiomes

@AsOf("3.0.0")
static MatchingBiomesPredicate.Builder matchingBiomes()

Starts building a MatchingBiomesPredicate, which checks that the biome at the block's position is one of the specified biomes.

Returns:

a new MatchingBiomesPredicate.Builder

Since:

3.0.0

See Also:

• MatchingBiomesPredicate

matchingBlockTag

@AsOf("3.0.0")
static MatchingBlockTagPredicate.Builder matchingBlockTag()

Starts building a MatchingBlockTagPredicate, which checks that the block at an offset is in the given block tag.

Returns:

a new MatchingBlockTagPredicate.Builder

Since:

3.0.0

See Also:

• MatchingBlockTagPredicate

matchingBlockTag

@AsOf("3.0.0")
static MatchingBlockTagPredicate matchingBlockTag(Tag<Material> tag)

Creates a MatchingBlockTagPredicate that matches the block at the given offset.

Parameters:

tag - the tag to match

Returns:

the matching block tag predicate

Since:

3.0.0

matchingBlockTag

@AsOf("3.0.0")
static MatchingBlockTagPredicate matchingBlockTag(ResourceKey tag)

Creates a MatchingBlockTagPredicate that matches the block at the given offset.

Parameters:

tag - the tag to match

Returns:

the matching block tag predicate

Since:

3.0.0

matchingBlocks

@AsOf("3.0.0")
static MatchingBlocksPredicate.Builder matchingBlocks()

Starts building a MatchingBlocksPredicate, which checks that the block at an offset is one of the specified blocks.

Returns:

a new MatchingBlocksPredicate.Builder

Since:

3.0.0

See Also:

• MatchingBlocksPredicate

matchingFluids

@AsOf("3.0.0")
static MatchingFluidsPredicate.Builder matchingFluids()

Starts building a MatchingFluidsPredicate, which checks that the fluid at an offset is one of the specified fluids.

Returns:

a new MatchingFluidsPredicate.Builder

Since:

3.0.0

See Also:

• MatchingFluidsPredicate

not

@AsOf("3.0.0")
static NotPredicate not(BlockPredicate predicate)

Creates a NotPredicate that inverts the given predicate.

Parameters:

predicate - the predicate to invert

Returns:

the negated predicate

Since:

3.0.0

See Also:

• NotPredicate

replaceable

@AsOf("3.0.0")
static ReplaceablePredicate.Builder replaceable()

Starts building a ReplaceablePredicate, which checks that the block at an offset can be replaced by placing blocks.

Returns:

a new ReplaceablePredicate.Builder

Since:

3.0.0

See Also:

• ReplaceablePredicate

solid

@Deprecated
@AsOf("3.0.0")
static SolidPredicate.Builder solid()

Deprecated.

Deprecated in Minecraft in favor of hasSturdyFace().

Starts building a SolidPredicate, which checks that the block at an offset is solid.

Returns:

a new SolidPredicate.Builder

Since:

3.0.0

See Also:

• SolidPredicate

alwaysTrue

@AsOf("3.0.0")
static TrueBlockPredicate alwaysTrue()

Returns the TrueBlockPredicate singleton, which always matches regardless of the block.

Returns:

the always-matching predicate

Since:

3.0.0

See Also:

• TrueBlockPredicate

wouldSurvive

@AsOf("3.0.0")
static WouldSurvivePredicate.Builder wouldSurvive()

Starts building a WouldSurvivePredicate, which checks that a block state would be a valid placement at the given offset.

Returns:

a new WouldSurvivePredicate.Builder

Since:

3.0.0

See Also:

• WouldSurvivePredicate

decode

@AsOf("3.3.0")
static BlockPredicate decode(Object minecraftPredicate)

Reads a Minecraft block predicate into a wrapper.

Parameters:

minecraftPredicate - the Minecraft predicate to read

Returns:

the wrapper for the predicate

Since:

3.3.0