Record Class EnvironmentScanPlacement

java.lang.Object
java.lang.Record
net.minecraft.world.level.levelgen.placement.EnvironmentScanPlacement
All Implemented Interfaces:
PlacementModifier
public record EnvironmentScanPlacement(Direction directionOfSearch, BlockPredicate targetCondition, BlockPredicate allowedSearchCondition, int maxSteps) extends Record implements PlacementModifier

  • Field Details

    • directionOfSearch

      private final Direction directionOfSearch
      The field for the directionOfSearch record component.

    • targetCondition

      private final BlockPredicate targetCondition
      The field for the targetCondition record component.

    • allowedSearchCondition

      private final BlockPredicate allowedSearchCondition
      The field for the allowedSearchCondition record component.

    • maxSteps

      private final int maxSteps
      The field for the maxSteps record component.

    • CODEC

      public static final com.mojang.serialization.MapCodec<EnvironmentScanPlacement> CODEC

  • Constructor Details

    • EnvironmentScanPlacement

      public EnvironmentScanPlacement(Direction 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

    • scanningFor

      public static EnvironmentScanPlacement scanningFor(Direction directionOfSearch, BlockPredicate targetCondition, BlockPredicate allowedSearchCondition, int maxSteps)

    • scanningFor

      public static EnvironmentScanPlacement scanningFor(Direction directionOfSearch, BlockPredicate targetCondition, int maxSteps)

    • modify

      public void modify(PlacementContext context, RandomSource random, BlockPos origin, Consumer<BlockPos> output)
      Specified by:
      modify in interface PlacementModifier

    • codec

      public com.mojang.serialization.MapCodec<EnvironmentScanPlacement> codec()
      Specified by:
      codec in interface PlacementModifier

    • 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 Direction 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