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

Interface ImmutableBreathingData

All Superinterfaces:

DataSerializable, ImmutableDataManipulator<ImmutableBreathingData,BreathingData>, ValueContainer<ImmutableBreathingData>

public interface ImmutableBreathingData
extends ImmutableDataManipulator<ImmutableBreathingData,BreathingData>

An ImmutableDataManipulator representing the current "air" quantity that an Entity can have while "under water".

Method Summary

Modifier and Type	Method and Description
ImmutableBoundedValue<Integer>	maxAir() Gets the ImmutableBoundedValue for the maximum air capacity.
ImmutableBoundedValue<Integer>	remainingAir() Gets the ImmutableBoundedValue for the remaining air.

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

remainingAir

ImmutableBoundedValue<Integer> remainingAir()

Gets the ImmutableBoundedValue for the remaining air. Can be changed to (air >= 0 && air <= maxAir).

Returns:

The immutable value of remaining air

maxAir

ImmutableBoundedValue<Integer> maxAir()

Gets the ImmutableBoundedValue for the maximum air capacity. The reasoning for it being bounded is that the air capacity must always remain at least 1.

Returns:

The immutable bounded value of maximum air capacity