Record Class CanyonCarverConfiguration

java.lang.Object
java.lang.Record
dev.wyck.wrapper.worldgen.carver.CanyonCarverConfiguration
All Implemented Interfaces:
Wrapper, CarverConfiguration, FeatureConfiguration
@NullMarked @AsOf("2.3.0") public record CanyonCarverConfiguration(float probability, HeightProvider y, FloatProvider yScale, VerticalAnchor lavaLevel, CarverDebugSettings debugSettings, Collection<Material> replaceable, FloatProvider verticalRotation, CanyonShapeConfiguration shape) extends Record implements CarverConfiguration
Wraps Minecraft's CanyonCarverConfiguration, the configuration consumed by the CANYON carver.
Since:
2.3.0

  • Constructor Details

    • CanyonCarverConfiguration

      @AsOf("2.3.0") public CanyonCarverConfiguration(float probability, HeightProvider y, FloatProvider yScale, VerticalAnchor lavaLevel, CarverDebugSettings debugSettings, Collection<Material> replaceable, FloatProvider verticalRotation, CanyonShapeConfiguration shape)
      Creates an instance of a CanyonCarverConfiguration record class.
      Parameters:
      probability - the value for the probability record component
      y - the value for the y record component
      yScale - the value for the yScale record component
      lavaLevel - the value for the lavaLevel record component
      debugSettings - the value for the debugSettings record component
      replaceable - the value for the replaceable record component
      verticalRotation - the value for the verticalRotation record component
      shape - the value for the shape record component

  • Method Details

    • builder

      @AsOf("2.3.0") public static CanyonCarverConfiguration.Builder builder()
      Creates a new Builder for CanyonCarverConfiguration.
      Returns:
      a new Builder for CanyonCarverConfiguration
      Since:
      2.3.0

    • toMinecraft

      @AsOf("2.3.0") public Object toMinecraft()
      Converts this CanyonCarverConfiguration to an NMS CanyonCarverConfiguration.
      Specified by:
      toMinecraft in interface FeatureConfiguration
      Specified by:
      toMinecraft in interface Wrapper
      Returns:
      the NMS CanyonCarverConfiguration
      Since:
      2.3.0

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

    • probability

      public float probability()
      Returns the value of the probability record component.
      Specified by:
      probability in interface CarverConfiguration
      Returns:
      the value of the probability record component

    • y

      public HeightProvider y()
      Returns the value of the y record component.
      Specified by:
      y in interface CarverConfiguration
      Returns:
      the value of the y record component

    • yScale

      public FloatProvider yScale()
      Returns the value of the yScale record component.
      Specified by:
      yScale in interface CarverConfiguration
      Returns:
      the value of the yScale record component

    • lavaLevel

      public VerticalAnchor lavaLevel()
      Returns the value of the lavaLevel record component.
      Specified by:
      lavaLevel in interface CarverConfiguration
      Returns:
      the value of the lavaLevel record component

    • debugSettings

      public CarverDebugSettings debugSettings()
      Returns the value of the debugSettings record component.
      Specified by:
      debugSettings in interface CarverConfiguration
      Returns:
      the value of the debugSettings record component

    • replaceable

      public Collection<Material> replaceable()
      Returns the value of the replaceable record component.
      Specified by:
      replaceable in interface CarverConfiguration
      Returns:
      the value of the replaceable record component

    • verticalRotation

      public FloatProvider verticalRotation()
      Returns the value of the verticalRotation record component.
      Returns:
      the value of the verticalRotation record component

    • shape

      public CanyonShapeConfiguration shape()
      Returns the value of the shape record component.
      Returns:
      the value of the shape record component