Record Class BlockPredicate

java.lang.Object

java.lang.Record

net.minestom.server.instance.block.predicate.BlockPredicate

Record Components:

blocks - The block names/tags to match.

state - The block properties to match.

nbt - The block nbt to match.

All Implemented Interfaces:

Predicate<Block>

public record BlockPredicate(@Nullable RegistryTag<Block> blocks, @Nullable PropertiesPredicate state, @Nullable net.kyori.adventure.nbt.CompoundBinaryTag nbt, @NotNull DataComponentPredicates components)
extends Record
implements Predicate<Block>

A predicate to filter blocks based on their name, properties, and/or nbt.

Note: Inline with vanilla, providing none of the filters will match any block.

Note: To match the vanilla behavior of comparing block NBT, the NBT predicate will ONLY match data which would be sent to the client eg with BlockHandler.getBlockEntityTags(). This is relevant because this structure is used for matching adventure mode blocks and must line up with client prediction.

Field Summary

Fields

Modifier and Type	Field	Description
static final BlockPredicate	ALL	Matches all blocks.
static final StructCodec<BlockPredicate>	CODEC
static final NetworkBuffer.Type<BlockPredicate>	NETWORK_TYPE
static final BlockPredicate	NONE	Matches no blocks.

Constructor Summary

Constructors

Constructor	Description
BlockPredicate(@NotNull net.kyori.adventure.nbt.CompoundBinaryTag nbt)
BlockPredicate(@NotNull Block... blocks)
BlockPredicate(@NotNull PropertiesPredicate state)
BlockPredicate(@NotNull RegistryTag<Block> blocks)
BlockPredicate(@Nullable RegistryTag<Block> blocks, @Nullable PropertiesPredicate state, @Nullable net.kyori.adventure.nbt.CompoundBinaryTag nbt)
BlockPredicate(@Nullable RegistryTag<Block> blocks, @Nullable PropertiesPredicate state, @Nullable net.kyori.adventure.nbt.CompoundBinaryTag nbt, @NotNull DataComponentPredicates components)	Creates an instance of a BlockPredicate record class.

Method Summary

Modifier and Type	Method	Description
@Nullable RegistryTag<Block>	blocks()	Returns the value of the blocks record component.
@NotNull DataComponentPredicates	components()	Returns the value of the components record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
@Nullable net.kyori.adventure.nbt.CompoundBinaryTag	nbt()	Returns the value of the nbt record component.
@Nullable PropertiesPredicate	state()	Returns the value of the state record component.
boolean	test(@NotNull Block block)
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.function.Predicate

and, negate, or

Field Details

ALL

public static final BlockPredicate ALL

Matches all blocks.

NONE

public static final BlockPredicate NONE

Matches no blocks.

Works based on the property that an exact property will never match a property which doesnt exist on any block.

NETWORK_TYPE

public static final NetworkBuffer.Type<BlockPredicate> NETWORK_TYPE

CODEC

public static final StructCodec<BlockPredicate> CODEC

Constructor Details

BlockPredicate

public BlockPredicate(@NotNull
 @NotNull RegistryTag<Block> blocks)

BlockPredicate

public BlockPredicate(@NotNull
 @NotNull Block... blocks)

BlockPredicate

public BlockPredicate(@NotNull
 @NotNull PropertiesPredicate state)

BlockPredicate

public BlockPredicate(@NotNull
 @NotNull net.kyori.adventure.nbt.CompoundBinaryTag nbt)

BlockPredicate

public BlockPredicate(@Nullable
 @Nullable RegistryTag<Block> blocks,
 @Nullable
 @Nullable PropertiesPredicate state,
 @Nullable
 @Nullable net.kyori.adventure.nbt.CompoundBinaryTag nbt)

BlockPredicate

public BlockPredicate(@Nullable
 @Nullable RegistryTag<Block> blocks,
 @Nullable
 @Nullable PropertiesPredicate state,
 @Nullable
 @Nullable net.kyori.adventure.nbt.CompoundBinaryTag nbt,
 @NotNull
 @NotNull DataComponentPredicates components)

Creates an instance of a BlockPredicate record class.

Parameters:

blocks - the value for the blocks record component

state - the value for the state record component

nbt - the value for the nbt record component

components - the value for the components record component

Method Details

test

public boolean test(@NotNull
 @NotNull Block block)

Specified by:

test in interface Predicate<Block>

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

blocks

@Nullable
public @Nullable RegistryTag<Block> blocks()

Returns the value of the blocks record component.

Returns:

the value of the blocks record component

state

@Nullable
public @Nullable PropertiesPredicate state()

Returns the value of the state record component.

Returns:

the value of the state record component

nbt

@Nullable
public @Nullable net.kyori.adventure.nbt.CompoundBinaryTag nbt()

Returns the value of the nbt record component.

Returns:

the value of the nbt record component

components

@NotNull
public @NotNull DataComponentPredicates components()

Returns the value of the components record component.

Returns:

the value of the components record component