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
private static class	FluidRegistry.FluidDelegate
static class	FluidRegistry.FluidRegisterEvent

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static java.util.Set<java.lang.String>	bucketFluids
(package private) static java.util.Set<Fluid>	currentBucketFluids
(package private) static com.google.common.collect.BiMap<java.lang.String,java.lang.String>	defaultFluidName
(package private) static java.util.Map<Fluid,FluidRegistry.FluidDelegate>	delegates
(package private) static com.google.common.collect.BiMap<Block,Fluid>	fluidBlocks
(package private) static com.google.common.collect.BiMap<Fluid,java.lang.Integer>	fluidIDs
(package private) static com.google.common.collect.BiMap<java.lang.Integer,java.lang.String>	fluidNames
(package private) static com.google.common.collect.BiMap<java.lang.String,Fluid>	fluids
static Fluid	LAVA
(package private) static com.google.common.collect.BiMap<java.lang.String,Fluid>	masterFluidReference
(package private) static int	maxID
(package private) static boolean	universalBucketEnabled
static Fluid	WATER

Constructor Summary

Constructors

Modifier	Constructor and Description
private	FluidRegistry()

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.lang.String	getModId(FluidStack fluidStack)
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 boolean	hasBucket(Fluid fluid)
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 boolean	isUniversalBucketEnabled()
private static void	loadFluidDefaults(com.google.common.collect.BiMap<Fluid,java.lang.Integer> localFluidIDs, java.util.Set<java.lang.String> defaultNames) Called by forge to load default fluid IDs from the world or from server -> client for syncing DO NOT call this and expect useful behaviour.
static void	loadFluidDefaults(NBTTagCompound tag)
static Fluid	lookupFluidForBlock(Block block)
(package private) static IRegistryDelegate<Fluid>	makeDelegate(Fluid fl)
static boolean	registerFluid(Fluid fluid) Register a new Fluid.
private static java.lang.String	uniqueName(Fluid 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

maxID

static int maxID

fluids

static com.google.common.collect.BiMap<java.lang.String,Fluid> fluids

fluidIDs

static com.google.common.collect.BiMap<Fluid,java.lang.Integer> fluidIDs

fluidNames

static com.google.common.collect.BiMap<java.lang.Integer,java.lang.String> fluidNames

fluidBlocks

static com.google.common.collect.BiMap<Block,Fluid> fluidBlocks

masterFluidReference

static com.google.common.collect.BiMap<java.lang.String,Fluid> masterFluidReference

defaultFluidName

static com.google.common.collect.BiMap<java.lang.String,java.lang.String> defaultFluidName

delegates

static java.util.Map<Fluid,FluidRegistry.FluidDelegate> delegates

universalBucketEnabled

static boolean universalBucketEnabled

bucketFluids

static java.util.Set<java.lang.String> bucketFluids

currentBucketFluids

static java.util.Set<Fluid> currentBucketFluids

WATER

public static final Fluid WATER

LAVA

public static final Fluid LAVA

Constructor Detail

FluidRegistry

private FluidRegistry()

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.

loadFluidDefaults

private static void loadFluidDefaults(com.google.common.collect.BiMap<Fluid,java.lang.Integer> localFluidIDs,
                                      java.util.Set<java.lang.String> defaultNames)

Called by forge to load default fluid IDs from the world or from server -> client for syncing DO NOT call this and expect useful behaviour.

Parameters:

localFluidIDs -

defaultNames -

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

uniqueName

private static java.lang.String uniqueName(Fluid fluid)

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

@Nullable
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:

A read-only set containing the fluids

hasBucket

public static boolean hasBucket(Fluid fluid)

lookupFluidForBlock

public static Fluid lookupFluidForBlock(Block block)

getMaxID

public static int getMaxID()

getDefaultFluidName

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

getModId

@Nullable
public static java.lang.String getModId(@Nullable
                                                  FluidStack fluidStack)

loadFluidDefaults

public static void loadFluidDefaults(NBTTagCompound tag)

writeDefaultFluidList

public static void writeDefaultFluidList(NBTTagCompound forgeData)

validateFluidRegistry

public static void validateFluidRegistry()

makeDelegate

static IRegistryDelegate<Fluid> makeDelegate(Fluid fl)