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

Interface HealthData

All Superinterfaces:

DataManipulator<HealthData,ImmutableHealthData>, DataSerializable, ValueContainer<HealthData>

public interface HealthData
extends DataManipulator<HealthData,ImmutableHealthData>

An DataManipulator containing health specific information for a Living entity. Usually just signifying that an Entity has "health" and can "die" once the health is depleted.

Method Summary

Modifier and Type	Method and Description
MutableBoundedValue<Double>	health() Returns the health amount.
MutableBoundedValue<Double>	maxHealth() Gets the current maximum health.

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

health

MutableBoundedValue<Double> health()

Returns the health amount.

The range of the health depends on the object on which this method is defined. For players in Minecraft, the nominal range is between 0 and 20, inclusive, but the range can be adjusted.

Convention dictates that health does not follow below 0 but this convention may be broken.

Returns:

Health value

See Also:

Keys.HEALTH

maxHealth

MutableBoundedValue<Double> maxHealth()

Gets the current maximum health.

The maximum health set here may affect the attribute increasing health points. The base health should be minded that it may be lower than the total maximum health of this entity.

Returns:

This entities maximum health

See Also:

Keys.MAX_HEALTH