Package io.papermc.paper.datacomponent.item

Interface FoodProperties

All Superinterfaces:
BuildableDataComponent<FoodProperties,FoodProperties.Builder>
@NullMarked @Experimental @NonExtendable public interface FoodProperties extends BuildableDataComponent<FoodProperties,FoodProperties.Builder>
Holds the food properties of an item.
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    FoodProperties.Builder
    Builder for FoodProperties.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canAlwaysEat()
    If true, this food can be eaten even if not hungry.
    static FoodProperties.Builder
    food()
     
    @org.checkerframework.checker.index.qual.NonNegative int
    nutrition()
    Number of food points to restore when eaten.
    float
    saturation()
    Amount of saturation to restore when eaten.

    Methods inherited from interface io.papermc.paper.datacomponent.BuildableDataComponent

    toBuilder

  • Method Details

    • food

      @Contract(value="-> new", pure=true) static FoodProperties.Builder food()

    • nutrition

      @Contract(pure=true) @org.checkerframework.checker.index.qual.NonNegative int nutrition()
      Number of food points to restore when eaten.
      Returns:
      the nutrition

    • saturation

      @Contract(pure=true) float saturation()
      Amount of saturation to restore when eaten.
      Returns:
      the saturation

    • canAlwaysEat

      @Contract(pure=true) boolean canAlwaysEat()
      If true, this food can be eaten even if not hungry.
      Returns:
      can always be eaten