0.0.1

NollyAPI/com.thenolle.api.nollyapi.util.item.type/FoodItem

FoodItem

class FoodItem(name: String, material: Material = Material.COOKED_BEEF)

Represents a custom food item with customizable properties and effects.

This class allows the creation of food items that can restore hunger and saturation, apply potion effects upon consumption, and have additional features like the ability to always be eaten or conversion into another item. The created food item can be used as a CustomItem, which can be registered and given to players.

Parameters

name

The name of the food item.

material

The Material of the food item (default is COOKED_BEEF).

Constructors

constructor(name: String, material: Material = Material.COOKED_BEEF)

Functions

fun addEffect(effect: PotionEffect, probability: Float): FoodItem

Adds a potion effect to the food item, which will be applied with a certain probability upon consumption.

fun build(id: String): CustomItem

Builds and returns the CustomItem representation of the food item.

fun canAlwaysEat(): FoodItem

Makes the food item always consumable, even when the player is not hungry.

eatingConvertsTo

fun eatingConvertsTo(item: ItemStack): FoodItem

Sets the item that the food will convert to once it is eaten.

fun eatSeconds(seconds: Float): FoodItem

Sets the time (in seconds) it takes to eat the food item.

fun glow(): FoodItem

Adds a glowing effect to the food item.

fun hunger(points: Int): FoodItem

Sets the number of hunger points the food item restores.

fun lore(vararg lines: String): FoodItem

Adds lore to the food item.

fun saturation(amount: Float): FoodItem

Sets the saturation the food item provides.

fun unbreakable(): FoodItem

Marks the food item as unbreakable.