Class FoodItem

Define a food item.

Index

Constructors

Properties

eatEvent? statusEffects? typeId

Methods

Constructors

constructor

new FoodItem(typeId, statusEffects?, eatEvent?): FoodItem
Parameters
- typeId: string
  Identifier of the type of items for the stack. If a namespace is not specified, 'minecraft:' is assumed.
- OptionalstatusEffects: EffectData[]
  Adds a status effect when eat the food.
- OptionaleatEvent: ((arg: ItemCompleteUseAfterEvent) => void)
  This event fires when eat the food.
  - - (arg): void
    - Parameters
      arg: ItemCompleteUseAfterEvent
      Returns void
Returns FoodItem
- Defined in lazuli-api/item/food.ts:9

Properties

`Optional`eatEvent

eatEvent?: ((arg: ItemCompleteUseAfterEvent) => void)

This event fires when eat the food.

`Optional`statusEffects

statusEffects?: EffectData[]

Adds a status effect when eat the food.

`Readonly`typeId

typeId: string

Identifier of the type of items for the stack. If a namespace is not specified, 'minecraft:' is assumed.

Methods

`Protected`register

register(): void
Registry the food.

Returns void
Deprecated
Use Register.foodRegistry() to registry the food.
- Defined in lazuli-api/item/food.ts:27