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

Interface ImmutableHealthData

All Superinterfaces:

DataSerializable, ImmutableDataManipulator<ImmutableHealthData,HealthData>, ValueContainer<ImmutableHealthData>

public interface ImmutableHealthData
extends ImmutableDataManipulator<ImmutableHealthData,HealthData>

An ImmutableDataManipulator 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
ImmutableBoundedValue<Double>	health() Gets an ImmutableBoundedValue for the current health.
ImmutableBoundedValue<Double>	maxHealth() Gets an ImmutableBoundedValue for the maximum health.

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

health

ImmutableBoundedValue<Double> health()

Gets an ImmutableBoundedValue for the current health.

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 for any reason.

Returns:

Health value

maxHealth

ImmutableBoundedValue<Double> maxHealth()

Gets an ImmutableBoundedValue for the 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