me.desht.pneumaticcraft.common.fluid

Enum FuelRegistry

java.lang.Object

java.lang.Enum<FuelRegistry>

me.desht.pneumaticcraft.common.fluid.FuelRegistry

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FuelRegistry>, IFuelRegistry

public enum FuelRegistry
extends java.lang.Enum<FuelRegistry>
implements IFuelRegistry

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
void	clearCachedFuelFluids()
float	getBurnRateMultiplier(net.minecraft.world.World world, net.minecraft.fluid.Fluid fluid) Get the burn rate of the given fluid.
int	getFuelValue(net.minecraft.world.World world, net.minecraft.fluid.Fluid fluid) Get the fuel value of the given fluid; this is defined as the amount of compressed air generated in a Liquid Compressor (without Speed Upgrades) by burning 1000mL of the fluid.
static FuelRegistry	getInstance()
java.util.Collection<net.minecraft.fluid.Fluid>	registeredFuels(net.minecraft.world.World world) Get all the known fuels which have been registered with the fuel registry.
void	registerFuel(net.minecraft.tags.ITag<net.minecraft.fluid.Fluid> fluidTag, int mLPerBucket, float burnRateMultiplier) Adds a burnable fluid to the Liquid Compressor's available burnable fuels.
void	registerHotFluid(net.minecraft.fluid.Fluid fluid, int mLPerBucket, float burnRateMultiplier)
static FuelRegistry	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FuelRegistry[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface me.desht.pneumaticcraft.api.fuel.IFuelRegistry

getBurnRateMultiplier, getFuelValue, registerFuel

Enum Constant Detail

INSTANCE

public static final FuelRegistry INSTANCE

Method Detail

values

public static FuelRegistry[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FuelRegistry c : FuelRegistry.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FuelRegistry valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getInstance

public static FuelRegistry getInstance()

registerFuel

public void registerFuel(net.minecraft.tags.ITag<net.minecraft.fluid.Fluid> fluidTag,
                         int mLPerBucket,
                         float burnRateMultiplier)

Description copied from interface: IFuelRegistry

Adds a burnable fluid to the Liquid Compressor's available burnable fuels. This also allows a bucket of that fluid to be used in furnaces, the burn time being half the mLPerBucket value.

Specified by:

registerFuel in interface IFuelRegistry

Parameters:

fluidTag - the fluid tag to register

mLPerBucket - the amount of mL of air generated by burning 1000mB of the fuel in a Liquid Compressor. For comparison, one piece of coal generates 16000mL in an Air Compressor.

burnRateMultiplier - fuel burn rate multiplier; larger numbers mean the fuel burns faster and produces air more quickly. The total amount of air produced does not change.

registerHotFluid

public void registerHotFluid(net.minecraft.fluid.Fluid fluid,
                             int mLPerBucket,
                             float burnRateMultiplier)

getFuelValue

public int getFuelValue(net.minecraft.world.World world,
                        net.minecraft.fluid.Fluid fluid)

Description copied from interface: IFuelRegistry

Get the fuel value of the given fluid; this is defined as the amount of compressed air generated in a Liquid Compressor (without Speed Upgrades) by burning 1000mL of the fluid.

Specified by:

getFuelValue in interface IFuelRegistry

fluid - the fluid

Returns:

the fuel value (0 for fluids which have not been registered as fuels)

getBurnRateMultiplier

public float getBurnRateMultiplier(net.minecraft.world.World world,
                                   net.minecraft.fluid.Fluid fluid)

Description copied from interface: IFuelRegistry

Get the burn rate of the given fluid. Higher burn rates will generate compressed air faster in a Liquid Compressor (and be used up faster), without affecting the total amount of air produced.

Specified by:

getBurnRateMultiplier in interface IFuelRegistry

fluid - the fluid

Returns:

the burn rate (1.0f is the standard, default, rate)

registeredFuels

public java.util.Collection<net.minecraft.fluid.Fluid> registeredFuels(net.minecraft.world.World world)

Description copied from interface: IFuelRegistry

Get all the known fuels which have been registered with the fuel registry. In the case of conflicts, precedence is as follows: 1) fluids from datapacks, 2) fluid tags from datapacks, 3) fluids from API registration (including built-in), 4) fluid tags from API registration

Note: this is a relatively expensive operation and should be used with care. Use IFuelRegistry.getFuelValue(Fluid) if you just need the value of a known fluid.

Specified by:

registeredFuels in interface IFuelRegistry

Parameters:

world - the world

Returns:

a collection of fuel fluids

clearCachedFuelFluids

public void clearCachedFuelFluids()