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

Interface BreathingData

All Superinterfaces:

DataManipulator<BreathingData,ImmutableBreathingData>, DataSerializable, ValueContainer<BreathingData>

public interface BreathingData
extends DataManipulator<BreathingData,ImmutableBreathingData>

Represents the remaining air information for various entities while they are underwater.

Method Summary

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

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

remainingAir

MutableBoundedValue<Integer> remainingAir()

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

Returns:

The mutable value of remaining air

See Also:

Keys.REMAINING_AIR

maxAir

MutableBoundedValue<Integer> maxAir()

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

Returns:

The mutable bounded value of maximum air capacity

See Also:

Keys.MAX_AIR