Class ItemTypeFoodComponent

constructor

• new ItemTypeFoodComponent(
      type: ItemType,
      options?: Partial<ItemTypeFoodComponentOptions>,
  ): ItemTypeFoodComponent

  Create a new food component for an item type.

  Parameters

  • type: ItemType

    The item type that the component will be attached to.
  • Optionaloptions: Partial<ItemTypeFoodComponentOptions>

    The options for the food component.

  Returns ItemTypeFoodComponent

Static Readonlyidentifier

getCanAlwaysEat

• getCanAlwaysEat(): boolean

  Get whether the item can always be eaten, regardless of hunger.

  Returns boolean

  True if the item can always be eaten, false otherwise.

getEffects

• getEffects(): {
      amplifier: number;
      chance: number;
      duration: number;
      id: number;
  }[]

  Get the effects that are applied when the food is consumed.

  Returns { amplifier: number; chance: number; duration: number; id: number }[]

  An array of the effect info.

getNutrition

• getNutrition(): number

  Get the nutrition value of the item.

  Returns number

  The nutrition value of the item, defaulting to 0 if not found.

  Note

  This value can be negative, which would result in hunger loss.

getSaturationModifier

• getSaturationModifier(): number

  Get the saturation modifier of the item.

  Returns number

  The saturation modifier of the item, defaulting to 0 if not found.

  Note

  This value must be greater than 0.

getUsingConvertsTo

• getUsingConvertsTo(): ItemType

  Get the item type that this food component converts to when used.

  Returns ItemType

  The item type that this food component converts to.

  Throws

  Error if the conversion item type is not set.

setCanAlwaysEat

• setCanAlwaysEat(value: boolean): void

  Set whether the item can always be eaten, regardless of hunger.

  Parameters

  • value: boolean

    True if the item can always be eaten, false otherwise.

  Returns void

setEffects

• setEffects(effects: ItemTypeFoodEffectOptions[]): void

  Set the effects that are applied when the food is consumed.

  Parameters

  • effects: ItemTypeFoodEffectOptions[]

    An array of the effect info to set.

  Returns void

setNutrition

• setNutrition(value: number): void

  Set the nutrition value of the item.

  Parameters

  • value: number

    The nutrition value to set for the item.

  Returns void

  Note

  This value can be negative, which would result in hunger loss.

setSaturationModifier

• setSaturationModifier(value: number): void

  Set the saturation modifier of the item.

  Parameters

  • value: number

    The saturation modifier to set for the item.

  Returns void

  Note

  This value must be greater than 0.

setUsingConvertsTo

• setUsingConvertsTo(type: ItemType): void

  Set the item type that this food component converts to when used.

  Parameters

  • type: ItemType

    The item type that this food component converts to.

  Returns void