org.spongepowered.api.data.manipulator.mutable.entity

Interface FoodData

All Superinterfaces:

DataManipulator<FoodData,ImmutableFoodData>, DataSerializable, ValueContainer<FoodData>

public interface FoodData
extends DataManipulator<FoodData,ImmutableFoodData>

An DataManipulator 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
MutableBoundedValue<Double>	exhaustion() Gets the MutableBoundedValue for the "exhaustion" level.
MutableBoundedValue<Integer>	foodLevel() Gets the current food level as an MutableBoundedValue.
MutableBoundedValue<Double>	saturation() Gets the MutableBoundedValue for the "saturation" level.

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

asImmutable, copy, fill, fill, from, set, set, set, set, transform

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

MutableBoundedValue<Integer> foodLevel()

Gets the current food level as an MutableBoundedValue.

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

See Also:

Keys.FOOD_LEVEL

exhaustion

MutableBoundedValue<Double> exhaustion()

Gets the MutableBoundedValue 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

See Also:

Keys.EXHAUSTION

saturation

MutableBoundedValue<Double> saturation()

Gets the MutableBoundedValue for the "saturation" 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

See Also:

Keys.SATURATION