Package net.neoforged.neoforge.registries.datamaps.builtin

Record Class Compostable

java.lang.Object
java.lang.Record
net.neoforged.neoforge.registries.datamaps.builtin.Compostable
Record Components:
chance - the chance that a compost is successful
canVillagerCompost - whether farmer villagers can compost the item
public record Compostable(float chance, boolean canVillagerCompost) extends Record
Data map value for compostables.

  • Field Details

    • chance

      private final float chance
      The field for the chance record component.

    • canVillagerCompost

      private final boolean canVillagerCompost
      The field for the canVillagerCompost record component.

    • CHANCE_CODEC

      public static final com.mojang.serialization.Codec<Compostable> CHANCE_CODEC

    • CODEC

      public static final com.mojang.serialization.Codec<Compostable> CODEC

  • Constructor Details

    • Compostable

      public Compostable(float chance)
      Constructs a Compostable that cannot be composted by farmer villagers.
      Parameters:
      chance - the chance that a compost is successful

    • Compostable

      public Compostable(float chance, boolean canVillagerCompost)
      Creates an instance of a Compostable record class.
      Parameters:
      chance - the value for the chance record component
      canVillagerCompost - the value for the canVillagerCompost 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 '=='.
      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.

    • chance

      public float chance()
      Returns the value of the chance record component.
      Returns:
      the value of the chance record component

    • canVillagerCompost

      public boolean canVillagerCompost()
      Returns the value of the canVillagerCompost record component.
      Returns:
      the value of the canVillagerCompost record component