Package org.geysermc.geyser.api.block.custom.component

Record Class PlacementConditions

java.lang.Object

java.lang.Record

org.geysermc.geyser.api.block.custom.component.PlacementConditions

Record Components:

allowedFaces - The faces that the block can be placed on

blockFilters - The block filters that control what blocks the block can be placed on

public record PlacementConditions(@NonNull Set<PlacementConditions.Face> allowedFaces, @NonNull LinkedHashMap<String,PlacementConditions.BlockFilterType> blockFilters)
extends Record

This class is used to store conditions for a placement filter for a custom block.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PlacementConditions.BlockFilterType
static enum	PlacementConditions.Face

Constructor Summary

Constructors

Constructor	Description
PlacementConditions(@NonNull Set<PlacementConditions.Face> allowedFaces, @NonNull LinkedHashMap<String,PlacementConditions.BlockFilterType> blockFilters)	Creates an instance of a PlacementConditions record class.

Method Summary

Modifier and Type	Method	Description
@NonNull Set<PlacementConditions.Face>	allowedFaces()	Returns the value of the allowedFaces record component.
@NonNull LinkedHashMap<String,PlacementConditions.BlockFilterType>	blockFilters()	Returns the value of the blockFilters 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.
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

Constructor Details

PlacementConditions

public PlacementConditions(@NonNull Set<PlacementConditions.Face> allowedFaces,
 @NonNull LinkedHashMap<String,PlacementConditions.BlockFilterType> blockFilters)

Creates an instance of a PlacementConditions record class.

Parameters:

allowedFaces - the value for the allowedFaces record component

blockFilters - the value for the blockFilters record component

Method Details

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.

allowedFaces

public @NonNull Set<PlacementConditions.Face> allowedFaces()

Returns the value of the allowedFaces record component.

Returns:

the value of the allowedFaces record component

blockFilters

public @NonNull LinkedHashMap<String,PlacementConditions.BlockFilterType> blockFilters()

Returns the value of the blockFilters record component.

Returns:

the value of the blockFilters record component