Edit

ItemFoodComponent Class

  • Article

Extends

When present on an item, this item is consumable by entities. Note that this component only applies to data-driven items.

Properties

canAlwaysEat

read-only canAlwaysEat: boolean;

If true, the player can always eat this item (even when not hungry).

Type: boolean

Warning

This property can throw errors when used.

nutrition

read-only nutrition: number;

Represents how much nutrition this food item will give an entity when eaten.

Type: number

Warning

This property can throw errors when used.

saturationModifier

read-only saturationModifier: number;

When an item is eaten, this value is used according to this formula (nutrition * saturation_modifier * 2) to apply a saturation buff.

Type: number

Warning

This property can throw errors when used.

usingConvertsTo

read-only usingConvertsTo: string;

When specified, converts the active item to the one specified by this property.

Type: string

Warning

This property can throw errors when used.

Constants

componentId

static read-only componentId = "minecraft:food";

Type: string