org.spongepowered.api.extra.fluid

Interface FluidStack.Builder

All Superinterfaces:

DataBuilder<FluidStack>, ResettableBuilder<FluidStack,DataBuilder<FluidStack>>

Enclosing interface:

FluidStack

public static interface FluidStack.Builder
extends DataBuilder<FluidStack>

Method Summary

Modifier and Type	Method and Description
FluidStack	build() Builds a new FluidStack based on the desired volume and FluidType.
FluidStack.Builder	fluid(FluidType fluidType) Sets the FluidType to use to build the FluidStack.
FluidStack.Builder	from(FluidStack value) Resets this builder to the values of the given built object.
FluidStack.Builder	from(FluidStackSnapshot fluidStackSnapshot) Resets and fills this builder with all the information from the provided FluidStackSnapshot.
FluidStack.Builder	reset() Resets this builder to a "default" state such that there is no remaining data to set.
FluidStack.Builder	volume(int volume) Sets the desired volume of the FluidStack.

Methods inherited from interface org.spongepowered.api.data.persistence.DataBuilder

build

Method Detail

fluid

FluidStack.Builder fluid(FluidType fluidType)

Sets the FluidType to use to build the FluidStack.

Parameters:

fluidType - The fluid type

Returns:

This builder, for chaining

volume

FluidStack.Builder volume(int volume)

Sets the desired volume of the 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.

Parameters:

volume - The volume

Returns:

This builder, for chaining

build

FluidStack build()

Builds a new FluidStack based on the desired volume and FluidType. If either are not set (invalid), an IllegalStateException may be thrown.

Returns:

The newly created fluid stack

from

FluidStack.Builder from(FluidStackSnapshot fluidStackSnapshot)

Resets and fills this builder with all the information from the provided FluidStackSnapshot.

Parameters:

fluidStackSnapshot - The fluid stack snapshot to copy data from

Returns:

This builder, for chaining

from

FluidStack.Builder from(FluidStack value)

Description copied from interface: ResettableBuilder

Resets this builder to the values of the given built object.

Specified by:

from in interface DataBuilder<FluidStack>

Specified by:

from in interface ResettableBuilder<FluidStack,DataBuilder<FluidStack>>

Parameters:

value - The built object

Returns:

This builder, for chaining

reset

FluidStack.Builder reset()

Description copied from interface: ResettableBuilder

Resets this builder to a "default" state such that there is no remaining data to set. This is to be the presumed "default" state.

Specified by:

reset in interface DataBuilder<FluidStack>

Specified by:

reset in interface ResettableBuilder<FluidStack,DataBuilder<FluidStack>>

Returns:

This builder, for chaining