Package net.minestom.server.item.component

Record Class Food

java.lang.Object
java.lang.Record
net.minestom.server.item.component.Food
public record Food(int nutrition, float saturationModifier, boolean canAlwaysEat) extends Record

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final BinaryTagSerializer<Food>
    NBT_TYPE
     
    static final NetworkBuffer.Type<Food>
    NETWORK_TYPE
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Food(int nutrition, float saturationModifier, boolean canAlwaysEat)
    Creates an instance of a Food record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canAlwaysEat()
    Returns the value of the canAlwaysEat 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
    nutrition()
    Returns the value of the nutrition record component.
    float
    saturationModifier()
    Returns the value of the saturationModifier record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • Food

      public Food(int nutrition, float saturationModifier, boolean canAlwaysEat)
      Creates an instance of a Food record class.
      Parameters:
      nutrition - the value for the nutrition record component
      saturationModifier - the value for the saturationModifier record component
      canAlwaysEat - the value for the canAlwaysEat 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.

    • nutrition

      public int nutrition()
      Returns the value of the nutrition record component.
      Returns:
      the value of the nutrition record component

    • saturationModifier

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

    • canAlwaysEat

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