nova.core.component.fluid

Class Fluid

java.lang.Object

nova.core.component.fluid.Fluid

All Implemented Interfaces:

java.lang.Cloneable, Storable, Identifiable

public class Fluid
extends java.lang.Object
implements Identifiable, Storable, java.lang.Cloneable

Field Summary

Fields

Modifier and Type	Field and Description
static int	bucketVolume 1000 liters = 1 cubic meter
FluidFactory	factory

Constructor Summary

Constructors

Constructor and Description
Fluid()

Method Summary

Modifier and Type	Method and Description
int	add(int amount) Adds fluid to this FluidStack
int	amount()
Fluid	clone()
boolean	equals(java.lang.Object o)
java.util.Optional<BlockFactory>	getBlockFactory() Gets the block associated with this fluid.
java.lang.String	getID() Get the ID to identify this object by
int	hashCode()
void	load(Data data) Loads all the data for this object.
int	remove(int amount) Removes fluid to this FluidStack
boolean	sameType(Fluid stack) Check if this FluidStack is of type of another FluidStack
void	save(Data data) Saves all the data of this object.
Fluid	setAmount(int amount) Sets new size of this FluidStack Note that there can never be fluid with "zero" amount.
Fluid	withAmount(int amount) Returns new FluidStack of the same Fluid with specified fluid

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface nova.core.util.Identifiable

sameType

Field Detail

bucketVolume

public static final int bucketVolume

1000 liters = 1 cubic meter

See Also:

Constant Field Values

factory

public FluidFactory factory

Constructor Detail

Fluid

public Fluid()

Method Detail

amount

public int amount()

Returns:

Amount of fluid

setAmount

public Fluid setAmount(int amount)

Sets new size of this FluidStack Note that there can never be fluid with "zero" amount. Use Optional.empty() instead.

Parameters:

amount - New size

Returns:

this instance

add

public int add(int amount)

Adds fluid to this FluidStack

Parameters:

amount - Amount of fluid to add

Returns:

Size added

remove

public int remove(int amount)

Removes fluid to this FluidStack

Parameters:

amount - Amount of fluid to remove

Returns:

Fluid removed

clone

public Fluid clone()

Overrides:

clone in class java.lang.Object

withAmount

public Fluid withAmount(int amount)

Returns new FluidStack of the same Fluid with specified fluid

Parameters:

amount - Amount of fluid in cloned FluidStack

Returns:

new FluidStack

getBlockFactory

public java.util.Optional<BlockFactory> getBlockFactory()

Gets the block associated with this fluid.

Returns:

The block. There may be no block associated with this fluid.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

sameType

public boolean sameType(Fluid stack)

Check if this FluidStack is of type of another FluidStack

Parameters:

stack - The another Fluid

Returns:

Result

getID

public final java.lang.String getID()

Description copied from interface: Identifiable

Get the ID to identify this object by

Specified by:

getID in interface Identifiable

Returns:

the ID

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

save

public void save(Data data)

Description copied from interface: Storable

Saves all the data of this object. See Data for what data is storable. The default implementation saves all fields tagged with @Store.

Specified by:

save in interface Storable

Parameters:

data - The data object to put values in.

load

public void load(Data data)

Description copied from interface: Storable

Loads all the data for this object. See Data for what data is storable. The default implementation loads all fields tagged with @Store.

Specified by:

load in interface Storable

Parameters:

data - The data object to load values from.