org.spongepowered.api.data.manipulator.immutable.entity

Interface ImmutableFoodData

All Superinterfaces:

DataSerializable, ImmutableDataManipulator<ImmutableFoodData,FoodData>, ValueContainer<ImmutableFoodData>

public interface ImmutableFoodData
extends ImmutableDataManipulator<ImmutableFoodData,FoodData>

An ImmutableDataManipulator handling the various aspects of "hunger" which has various effects on health and speed of Humanoid entities.

Method Summary

Modifier and Type	Method and Description
ImmutableBoundedValue<Double>	exhaustion() Gets the ImmutableBoundedValue for the "exhaustion" level.
ImmutableBoundedValue<Integer>	foodLevel() Gets the current food level as an ImmutableBoundedValue.
ImmutableBoundedValue<Double>	saturation() Gets the ImmutableBoundedValue for the "exhaustion" level.

Methods inherited from interface org.spongepowered.api.data.manipulator.ImmutableDataManipulator

asMutable, copy, with, with

Methods inherited from interface org.spongepowered.api.data.DataSerializable

getContentVersion, toContainer

Methods inherited from interface org.spongepowered.api.data.value.ValueContainer

get, getKeys, getOrElse, getOrNull, getValue, getValues, require, supports, supports

Method Detail

foodLevel

ImmutableBoundedValue<Integer> foodLevel()

Gets the current food level as an ImmutableBoundedValue.

Food level has health effects, depending on game difficulty and hunger levels. If the food level is high enough, the human entity may heal. If the food level is at 0, the human entity may starve.

Returns:

The current food level

exhaustion

ImmutableBoundedValue<Double> exhaustion()

Gets the ImmutableBoundedValue for the "exhaustion" level.

When the exhaustion level reaches 0, saturation is usually diminished such that saturation is decreased and then exhaustion is reset to the maximum. This type of effect occurs over time and can be modified by movements and actions performed by the Humanoid entity.

Returns:

The immutable bounded value of exhaustion

saturation

ImmutableBoundedValue<Double> saturation()

Gets the ImmutableBoundedValue for the "exhaustion" level.

When the saturation level reaches 0, the food level is usually diminished such that the food level is decreased by 1, then saturation is reset to the maximum value. This type of effect occurs over time and can be modified by movements and actions performed by the Humanoid entity.

Returns:

The immutable bounded value of saturation