net.minecraftforge.fluids

Class FluidRegistry

java.lang.Object

net.minecraftforge.fluids.FluidRegistry

public abstract class FluidRegistry
extends java.lang.Object

Handles Fluid registrations. Fluids MUST be registered in order to function.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FluidRegistry.FluidRegisterEvent

Field Summary

Fields

Modifier and Type	Field and Description
static Fluid	LAVA
static Fluid	WATER

Method Summary

Modifier and Type	Method and Description
static boolean	addBucketForFluid(Fluid fluid) Registers a fluid with the universal bucket.
static void	enableUniversalBucket() Enables the universal bucket in forge.
static java.util.Set<Fluid>	getBucketFluids() All fluids registered with the universal bucket
static java.lang.String	getDefaultFluidName(Fluid key)
static Fluid	getFluid(java.lang.String fluidName)
static java.lang.String	getFluidName(Fluid fluid)
static java.lang.String	getFluidName(FluidStack stack)
static FluidStack	getFluidStack(java.lang.String fluidName, int amount)
static int	getMaxID()
static java.util.Map<Fluid,java.lang.Integer>	getRegisteredFluidIDs() Deprecated.
static java.util.Map<java.lang.String,Fluid>	getRegisteredFluids() Returns a read-only map containing Fluid Names and their associated Fluids.
static void	initFluidIDs(<any> newfluidIDs, java.util.Set<java.lang.String> defaultNames) Called by Forge to prepare the ID map for server -> client sync.
static boolean	isFluidDefault(Fluid fluid) Is the supplied fluid the current default fluid for it's name
static boolean	isFluidRegistered(Fluid fluid) Does the supplied fluid have an entry for it's name (whether or not the fluid itself is default)
static boolean	isFluidRegistered(java.lang.String fluidName)
static boolean	isUniversalBucketEnabled()
static void	loadFluidDefaults(NBTTagCompound tag)
static Fluid	lookupFluidForBlock(Block block)
static boolean	registerFluid(Fluid fluid) Register a new Fluid.
static void	validateFluidRegistry()
static void	writeDefaultFluidList(NBTTagCompound forgeData)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

WATER

public static final Fluid WATER

LAVA

public static final Fluid LAVA

Method Detail

initFluidIDs

public static void initFluidIDs(<any> newfluidIDs,
                                java.util.Set<java.lang.String> defaultNames)

Called by Forge to prepare the ID map for server -> client sync. Modders, DO NOT call this.

registerFluid

public static boolean registerFluid(Fluid fluid)

Register a new Fluid. If a fluid with the same name already exists, registration the alternative fluid is tracked in case it is the default in another place

Parameters:

fluid - The fluid to register.

Returns:

True if the fluid was registered as the current default fluid, false if it was only registered as an alternative

isFluidDefault

public static boolean isFluidDefault(Fluid fluid)

Is the supplied fluid the current default fluid for it's name

Parameters:

fluid - the fluid we're testing

Returns:

if the fluid is default

isFluidRegistered

public static boolean isFluidRegistered(Fluid fluid)

Does the supplied fluid have an entry for it's name (whether or not the fluid itself is default)

Parameters:

fluid - the fluid we're testing

Returns:

if the fluid's name has a registration entry

isFluidRegistered

public static boolean isFluidRegistered(java.lang.String fluidName)

getFluid

public static Fluid getFluid(java.lang.String fluidName)

getFluidName

public static java.lang.String getFluidName(Fluid fluid)

getFluidName

public static java.lang.String getFluidName(FluidStack stack)

getFluidStack

public static FluidStack getFluidStack(java.lang.String fluidName,
                                       int amount)

getRegisteredFluids

public static java.util.Map<java.lang.String,Fluid> getRegisteredFluids()

Returns a read-only map containing Fluid Names and their associated Fluids.

getRegisteredFluidIDs

@Deprecated
public static java.util.Map<Fluid,java.lang.Integer> getRegisteredFluidIDs()

Deprecated.

Returns a read-only map containing Fluid Names and their associated IDs. Modders should never actually use this, use the String names.

enableUniversalBucket

public static void enableUniversalBucket()

Enables the universal bucket in forge. Has to be called before pre-initialization. Actually just call it statically in your mod class.

isUniversalBucketEnabled

public static boolean isUniversalBucketEnabled()

addBucketForFluid

public static boolean addBucketForFluid(Fluid fluid)

Registers a fluid with the universal bucket. This only has an effect if the universal bucket is enabled.

Parameters:

fluid - The fluid that the bucket shall be able to hold

Returns:

True if the fluid was added successfully, false if it already was registered or couldn't be registered with the bucket.

getBucketFluids

public static java.util.Set<Fluid> getBucketFluids()

All fluids registered with the universal bucket

Returns:

An immutable set containing the fluids

lookupFluidForBlock

public static Fluid lookupFluidForBlock(Block block)

getMaxID

public static int getMaxID()

getDefaultFluidName

public static java.lang.String getDefaultFluidName(Fluid key)

loadFluidDefaults

public static void loadFluidDefaults(NBTTagCompound tag)

writeDefaultFluidList

public static void writeDefaultFluidList(NBTTagCompound forgeData)

validateFluidRegistry

public static void validateFluidRegistry()