org.spongepowered.api.extra.fluid.data.manipulator.mutable

Interface FluidTankData

All Superinterfaces:

DataManipulator<FluidTankData,ImmutableFluidTankData>, DataSerializable, MappedData<Direction,List<FluidStackSnapshot>,FluidTankData,ImmutableFluidTankData>, ValueContainer<FluidTankData>

public interface FluidTankData
extends MappedData<Direction,List<FluidStackSnapshot>,FluidTankData,ImmutableFluidTankData>

The primary definition of a "tank" is that at any given Direction, the DataHolder may have multiple FluidStacks existing within itself. Granted, in most cases, the Direction doesn't quite matter as the tank itself is just a single container containing multiple FluidStacks, however, in some cases, mod added tanks may have different tanks for different directions. Note that setting an empty List of FluidStackSnapshots to a Direction is the functional equivalent to saying "remove all fluids from that direction".

Method Summary

Modifier and Type	Method and Description
default Optional<List<FluidStackSnapshot>>	fluidAtDirection(Direction direction) Gets the List of FluidStackSnapshots at a defined Direction.
MapValue<Direction,List<FluidStackSnapshot>>	fluids() Gets the MapValue of the various FluidStackSnapshots available from the owner.

Methods inherited from interface org.spongepowered.api.data.manipulator.mutable.MappedData

asMap, get, getMapKeys, getMapValue, getMapValues, put, putAll, remove

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

fluids

MapValue<Direction,List<FluidStackSnapshot>> fluids()

Gets the MapValue of the various FluidStackSnapshots available from the owner. Note that a fluid tank may have multiple FluidStacks differing based on Direction.

Returns:

The map value of direction to list of fluid snapshots

See Also:

Keys.FLUID_TANK_CONTENTS

fluidAtDirection

default Optional<List<FluidStackSnapshot>> fluidAtDirection(Direction direction)

Gets the List of FluidStackSnapshots at a defined Direction.

Parameters:

direction - The direction

Returns:

The list of fluid stack snapshots, if available