Record Class PlacementModifier.EnvironmentScanPlacement

java.lang.Object

java.lang.Record

dev.wyck.wrapper.worldgen.placement.PlacementModifier.EnvironmentScanPlacement

All Implemented Interfaces:

Wrapper, PlacementModifier

Enclosing interface:

PlacementModifier

@AsOf("2.3.0")
public static record PlacementModifier.EnvironmentScanPlacement(BlockFace directionOfSearch, BlockPredicate targetCondition, BlockPredicate allowedSearchCondition, int maxSteps)
extends Record
implements PlacementModifier

Since:

2.3.0

Nested Class Summary

Nested classes/interfaces inherited from interface PlacementModifier

PlacementModifier.BiomeFilter, PlacementModifier.BlockPredicateFilter, PlacementModifier.CountPlacement, PlacementModifier.EnvironmentScanPlacement, PlacementModifier.Factory, PlacementModifier.FixedPlacement, PlacementModifier.HeightmapPlacement, PlacementModifier.HeightRangePlacement, PlacementModifier.InSquarePlacement, PlacementModifier.NoiseBasedCountPlacement, PlacementModifier.NoiseThresholdCountPlacement, PlacementModifier.RandomOffsetPlacement, PlacementModifier.RarityFilter, PlacementModifier.SurfaceRelativeThresholdFilter, PlacementModifier.SurfaceWaterDepthFilter

Nested classes/interfaces inherited from interface Wrapper

Wrapper.Context<C>

Field Summary

Fields inherited from interface PlacementModifier

WIRE

Constructor Summary

Constructors

Constructor	Description
EnvironmentScanPlacement(BlockFace directionOfSearch, BlockPredicate targetCondition, BlockPredicate allowedSearchCondition, int maxSteps)	Creates an instance of a EnvironmentScanPlacement record class.

Method Summary

Modifier and Type	Method	Description
BlockPredicate	allowedSearchCondition()	Returns the value of the allowedSearchCondition record component.
BlockFace	directionOfSearch()	Returns the value of the directionOfSearch 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.
int	maxSteps()	Returns the value of the maxSteps record component.
BlockPredicate	targetCondition()	Returns the value of the targetCondition record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Methods inherited from interface PlacementModifier

toMinecraft

Methods inherited from interface Wrapper

asHandle

Constructor Details

EnvironmentScanPlacement

@AsOf("2.3.0")
public EnvironmentScanPlacement(BlockFace directionOfSearch,
 BlockPredicate targetCondition,
 BlockPredicate allowedSearchCondition,
 int maxSteps)

Creates an instance of a EnvironmentScanPlacement record class.

Parameters:

directionOfSearch - the value for the directionOfSearch record component

targetCondition - the value for the targetCondition record component

allowedSearchCondition - the value for the allowedSearchCondition record component

maxSteps - the value for the maxSteps 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

directionOfSearch

public BlockFace directionOfSearch()

Returns the value of the directionOfSearch record component.

Returns:

the value of the directionOfSearch record component

targetCondition

public BlockPredicate targetCondition()

Returns the value of the targetCondition record component.

Returns:

the value of the targetCondition record component

allowedSearchCondition

public BlockPredicate allowedSearchCondition()

Returns the value of the allowedSearchCondition record component.

Returns:

the value of the allowedSearchCondition record component

maxSteps

public int maxSteps()

Returns the value of the maxSteps record component.

Returns:

the value of the maxSteps record component