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

Interface ImmutableHealthScalingData

All Superinterfaces:

DataSerializable, ImmutableDataManipulator<ImmutableHealthScalingData,HealthScalingData>, ValueContainer<ImmutableHealthScalingData>

public interface ImmutableHealthScalingData
extends ImmutableDataManipulator<ImmutableHealthScalingData,HealthScalingData>

Method Summary

Modifier and Type	Method and Description
ImmutableBoundedValue<Double>	healthScale() Defines the amount of health to show client-side (in hearts) such that the maximum health is the value of this scale, and the current health is scaled as a ratio.

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

healthScale

ImmutableBoundedValue<Double> healthScale()

Defines the amount of health to show client-side (in hearts) such that the maximum health is the value of this scale, and the current health is scaled as a ratio.

If the current maximum health is 400, and the player has 200, but the scale dictates 20, then the client will see 5 hearts (or 10 half hearts) out of 10 hearts.

Returns:

The value for the health scale