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 int	renderIdFluid
static Fluid	WATER

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getDefaultFluidName(Fluid key)
static Fluid	getFluid(int fluidID)
static Fluid	getFluid(java.lang.String fluidName)
static int	getFluidID(Fluid fluid)
static int	getFluidID(java.lang.String fluidName)
static java.lang.String	getFluidName(Fluid fluid)
static java.lang.String	getFluidName(FluidStack stack)
static java.lang.String	getFluidName(int fluidID) Deprecated.
static FluidStack	getFluidStack(java.lang.String fluidName, int amount)
static int	getMaxID()
static java.util.Map<java.lang.String,java.lang.Integer>	getRegisteredFluidIDs() Deprecated.
static java.util.Map<Fluid,java.lang.Integer>	getRegisteredFluidIDsByFluid() Returns a read-only map containing Fluid IDs and their associated Fluids.
static java.util.Map<java.lang.String,Fluid>	getRegisteredFluids() Returns a read-only map containing Fluid Names and their associated Fluids.
static void	initFluidIDs(com.google.common.collect.BiMap<Fluid,java.lang.Integer> 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 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

renderIdFluid

public static int renderIdFluid

Method Detail

initFluidIDs

public static void initFluidIDs(com.google.common.collect.BiMap<Fluid,java.lang.Integer> 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)

getFluid

public static Fluid getFluid(int fluidID)

getFluidID

public static int getFluidID(Fluid fluid)

getFluidID

public static int getFluidID(java.lang.String fluidName)

getFluidName

@Deprecated
public static java.lang.String getFluidName(int fluidID)

Deprecated.

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<java.lang.String,java.lang.Integer> getRegisteredFluidIDs()

Deprecated.

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

getRegisteredFluidIDsByFluid

public static java.util.Map<Fluid,java.lang.Integer> getRegisteredFluidIDsByFluid()

Returns a read-only map containing Fluid IDs and their associated Fluids. In 1.8.3, this will change to just 'getRegisteredFluidIDs'

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()