org.spongepowered.api.extra.fluid

Interface FluidStack

All Superinterfaces:

CompositeValueStore<DataHolder,DataManipulator<?,?>>, DataHolder, DataSerializable, PropertyHolder, ValueContainer<DataHolder>

public interface FluidStack
extends DataHolder

Represents a stack of a particular FluidType and volume measured in "milliBuckets" where 1000mB is equal to 1 ItemTypes.BUCKET.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FluidStack.Builder

Method Summary

Modifier and Type	Method and Description
static FluidStack.Builder	builder() Creates a new FluidStack.Builder to make fluid stacks.
FluidStackSnapshot	createSnapshot() Creates a snapshot of this FluidStack.
FluidType	getFluid() Gets the FluidType for this fluid stack.
int	getVolume() Gets the "volume" of this FluidStack.
FluidStack	setVolume(int volume) Sets the desired volume for this stack.

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

setRawData, validateRawData

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.mutable.CompositeValueStore

copyFrom, copyFrom, get, getContainers, getOrCreate, offer, offer, offer, offer, offer, offer, remove, remove, remove, require, supports, transform, tryOffer, tryOffer, tryOffer, tryOffer, undo

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

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

Method Detail

builder

static FluidStack.Builder builder()

Creates a new FluidStack.Builder to make fluid stacks.

Returns:

The newly created builder

getFluid

FluidType getFluid()

Gets the FluidType for this fluid stack.

Returns:

The fluid type of this stack

getVolume

int getVolume()

Gets the "volume" of this FluidStack.

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 in milli buckets

setVolume

FluidStack setVolume(int volume)

Sets the desired volume for this stack.

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.

Parameters:

volume - The volume to set

Returns:

This fluid stack

createSnapshot

FluidStackSnapshot createSnapshot()

Creates a snapshot of this FluidStack.

Returns:

The fluid stack snapshot