Record Class ClampedInt

java.lang.Object
java.lang.Record
net.minecraft.util.valueproviders.ClampedInt
All Implemented Interfaces:
IntProvider
public record ClampedInt(IntProvider source, int minInclusive, int maxInclusive) extends Record implements IntProvider

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final com.mojang.serialization.MapCodec<ClampedInt>
    MAP_CODEC
     
    private final int
    maxInclusive
    The field for the maxInclusive record component.
    private final int
    minInclusive
    The field for the minInclusive record component.
    private final IntProvider
    source
    The field for the source record component.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ClampedInt(IntProvider source, int minInclusive, int maxInclusive)
    Creates an instance of a ClampedInt record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.mojang.serialization.MapCodec<ClampedInt>
    codec()
     
    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
    maxInclusive()
    Returns the value of the maxInclusive record component.
    int
    minInclusive()
    Returns the value of the minInclusive record component.
    static ClampedInt
    of(IntProvider source, int minInclusive, int maxInclusive)
     
    int
    sample(RandomSource random)
     
    IntProvider
    source()
    Returns the value of the source 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

  • Field Details

    • source

      private final IntProvider source
      The field for the source record component.

    • minInclusive

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

    • maxInclusive

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

    • MAP_CODEC

      public static final com.mojang.serialization.MapCodec<ClampedInt> MAP_CODEC

  • Constructor Details

    • ClampedInt

      public ClampedInt(IntProvider source, int minInclusive, int maxInclusive)
      Creates an instance of a ClampedInt record class.
      Parameters:
      source - the value for the source record component
      minInclusive - the value for the minInclusive record component
      maxInclusive - the value for the maxInclusive record component

  • Method Details

    • of

      public static ClampedInt of(IntProvider source, int minInclusive, int maxInclusive)

    • sample

      public int sample(RandomSource random)
      Specified by:
      sample in interface IntProvider

    • minInclusive

      public int minInclusive()
      Returns the value of the minInclusive record component.
      Specified by:
      minInclusive in interface IntProvider
      Returns:
      the value of the minInclusive record component

    • maxInclusive

      public int maxInclusive()
      Returns the value of the maxInclusive record component.
      Specified by:
      maxInclusive in interface IntProvider
      Returns:
      the value of the maxInclusive record component

    • codec

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

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

    • source

      public IntProvider source()
      Returns the value of the source record component.
      Returns:
      the value of the source record component