org.spongepowered.api.extra.fluid

Interface FluidStackSnapshot

All Superinterfaces:

DataSerializable, ImmutableDataHolder<FluidStackSnapshot>, ImmutableValueStore<FluidStackSnapshot,ImmutableDataManipulator<?,?>>, PropertyHolder, ValueContainer<FluidStackSnapshot>

public interface FluidStackSnapshot
extends ImmutableDataHolder<FluidStackSnapshot>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FluidStackSnapshot.Builder

Method Summary

Modifier and Type	Method and Description
static FluidStackSnapshot.Builder	builder() Creates a new FluidStackSnapshot.Builder to build a new FluidStackSnapshot.
FluidStack	createStack() Creates a new FluidStack based on this snapshot.
FluidType	getFluid() Gets the FluidType of this snapshot.
int	getVolume() Gets the volume of this snapshot.

Methods inherited from interface org.spongepowered.api.data.ImmutableDataHolder

getManipulators

Methods inherited from interface org.spongepowered.api.data.DataSerializable

getContentVersion, toContainer

Methods inherited from interface org.spongepowered.api.data.property.PropertyHolder

getApplicableProperties, getProperty

Methods inherited from interface org.spongepowered.api.data.value.immutable.ImmutableValueStore

get, getContainers, getOrCreate, merge, merge, supports, transform, with, with, with, with, without

Methods inherited from interface org.spongepowered.api.data.value.ValueContainer

copy, get, getKeys, getOrElse, getOrNull, getValue, getValues, require, supports, supports

Method Detail

builder

static FluidStackSnapshot.Builder builder()

Creates a new FluidStackSnapshot.Builder to build a new FluidStackSnapshot.

Returns:

The new builder

getFluid

FluidType getFluid()

Gets the FluidType of this snapshot.

Returns:

The fluid type

getVolume

int getVolume()

Gets the volume of this snapshot.

Note that the volume is measured in "milli buckets", otherwise read as mB. The scaling is as follows: 1 bucket = 1000mB, whereas 1 block usually equals 1000mB.

Returns:

The volume

createStack

FluidStack createStack()

Creates a new FluidStack based on this snapshot.

Returns:

The newly created stack