me.desht.pneumaticcraft.api.heat

Interface IHeatExchangerLogic

All Superinterfaces:

net.minecraftforge.common.util.INBTSerializable<net.minecraft.nbt.CompoundNBT>

All Known Subinterfaces:

IHeatExchangerAdapter

All Known Implementing Classes:

HeatExchangerLogicAmbient, HeatExchangerLogicConstant, HeatExchangerLogicTicking, IHeatExchangerAdapter.Simple, Mek2PNCHeatProvider.Mek2PNCHeatAdapter

public interface IHeatExchangerLogic
extends net.minecraftforge.common.util.INBTSerializable<net.minecraft.nbt.CompoundNBT>

Represents a heat exchanger owned by a tile entity. Retrieve instances of this via capability lookup; you can use PNCCapabilities.HEAT_EXCHANGER_CAPABILITY or get your own instance with @CapabilityInject.

If you are implementing a tile entity with a heat exchanger, you should not implement this interface yourself; get an instance of it via IHeatRegistry.makeHeatExchangerLogic(), store it as field in your TE, and provide via capability as described above. Your TE should also call tick() and initializeAsHull(World, BlockPos, BiPredicate, Direction...) as documented in those methods.

If you want to attach this capability as an adapater to other mods' heat systems, see IHeatExchangerAdapter and IHeatExchangerAdapter.Simple which are convenience extensions and implementations of this interface.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.function.BiPredicate<net.minecraft.world.IWorld,net.minecraft.util.math.BlockPos>	ALL_BLOCKS

Method Summary

Modifier and Type	Method and Description
default void	addConnectedExchanger(IHeatExchangerLogic exchanger) When called, this will create a thermal connection between this heat exchanger and the given one.
default void	addConnectedExchanger(IHeatExchangerLogic exchanger, boolean reciprocate)
void	addHeat(double amount) Adds heat (= deltaT * Thermal Capacity) to this exchanger.
default void	deserializeNBT(net.minecraft.nbt.CompoundNBT nbt)
double	getAmbientTemperature() Get the heat exchanger's ambient temperature, i.e.
default <T extends HeatBehaviour<?>> java.util.Optional<T>	getHeatBehaviour(net.minecraft.util.math.BlockPos pos, java.lang.Class<T> cls) Get the HeatBehaviour at the given position, which must be adjacent to this heat exchanger's owning tile entity, and in this heat exchanger's list of heat behaviours that it handles.
double	getTemperature() Get the heat exchanger's current (precise) temperature.
int	getTemperatureAsInt() Get the heat exchanger's current temperature to the nearest integer.
double	getThermalCapacity() Get this heat exchanger's thermal capacity.
double	getThermalResistance() Get this heat exchanger's thermal resistance.
void	initializeAmbientTemperature(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos) Initialize this heat exchanger's ambient temperature based on the given world & position.
void	initializeAsHull(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, java.util.function.BiPredicate<net.minecraft.world.IWorld,net.minecraft.util.math.BlockPos> blockFilter, net.minecraft.util.Direction... validSides) When called (on tile entity first tick and on neighbor block updates), this discovers all heat exchanging neighbor tile entities as connected heat exchangers (i.e.
boolean	isSideConnected(net.minecraft.util.Direction side) Check if this side of the heat exchanger has a thermal connection of any kind to the neighbouring block in the given direction; whether to another heat exchanger, a static heat source like air, or a custom handler such as a furnace or heat frame.
default void	removeConnectedExchanger(IHeatExchangerLogic exchanger) Disconnect a connected heat exchanger which was connected via addConnectedExchanger(IHeatExchangerLogic)
default void	removeConnectedExchanger(IHeatExchangerLogic exchanger, boolean reciprocate)
default net.minecraft.nbt.CompoundNBT	serializeNBT()
void	setTemperature(double temperature) Set the temperature of this heat exchanger.
void	setThermalCapacity(double capacity) Set this heat exchanger's thermal capacity.
void	setThermalResistance(double thermalResistance) The higher the thermal resistance, the slower the heat disperses.
void	tick() Call this to tick this logic, and make the heat disperse itself.

Field Detail

ALL_BLOCKS

static final java.util.function.BiPredicate<net.minecraft.world.IWorld,net.minecraft.util.math.BlockPos> ALL_BLOCKS

Method Detail

tick

void tick()

Call this to tick this logic, and make the heat disperse itself. In general this should be called each tick by the owning tile entity's tick() method, on the server side only.

initializeAsHull

void initializeAsHull(net.minecraft.world.World world,
                      net.minecraft.util.math.BlockPos pos,
                      java.util.function.BiPredicate<net.minecraft.world.IWorld,net.minecraft.util.math.BlockPos> blockFilter,
                      net.minecraft.util.Direction... validSides)

When called (on tile entity first tick and on neighbor block updates), this discovers all heat exchanging neighbor tile entities as connected heat exchangers (i.e. tile entities who provide the IHeatExchangerLogic capability on that side). It will also account for neighbouring blocks with special heat properties, like Magma or Lava, and other special cases like Heat Frames (which are entities).

You don't need to call this method if this heat exchanger is not connected to the outside world (e.g. the connecting heat exchanger within a Vortex Tube).

Parameters:

world - the world

pos - the position

blockFilter - a whitelist check; can be used to exclude certain blocks, e.g. air or fluids

validSides - an array of sides to check for heat exchanging neighbours

initializeAmbientTemperature

void initializeAmbientTemperature(net.minecraft.world.World world,
                                  net.minecraft.util.math.BlockPos pos)

Initialize this heat exchanger's ambient temperature based on the given world & position. You don't need to call this method if your heat exchanger is a hull exchanger (i.e. provides an IHeatExchangerLogic object via capability lookup), as hulls are automatically initialized by initializeAsHull(World, BlockPos, BiPredicate, Direction...)

Parameters:

world - the world

pos - the position

addConnectedExchanger

default void addConnectedExchanger(IHeatExchangerLogic exchanger)

When called, this will create a thermal connection between this heat exchanger and the given one. This should be used when your TE contains more than one heat exchanger and you need a thermal connection between them; an example is the Vortex Tube.

You don't need to call this method if your TE just has one heat exchanger to expose to the world; in that case initializeAsHull(World, BlockPos, BiPredicate, Direction...) will handle connecting your TE's heat exchanger to neighbouring blocks.

You should only call this method on one of the two heat exchangers being connected; a reciprocal connection on the target heat exchanger will automatically be added.

Parameters:

exchanger - the other heat exchanger

addConnectedExchanger

default void addConnectedExchanger(IHeatExchangerLogic exchanger,
                                   boolean reciprocate)

Parameters:

exchanger - the other heat exchanger

reciprocate - whether the other exchanger should also add this one

removeConnectedExchanger

default void removeConnectedExchanger(IHeatExchangerLogic exchanger)

Disconnect a connected heat exchanger which was connected via addConnectedExchanger(IHeatExchangerLogic)

Parameters:

exchanger - the other heat exchanger

removeConnectedExchanger

default void removeConnectedExchanger(IHeatExchangerLogic exchanger,
                                      boolean reciprocate)

Parameters:

exchanger - the other heat exchanger

reciprocate - whether the other exchanger should also add this one

setTemperature

void setTemperature(double temperature)

Set the temperature of this heat exchanger. By default, heat exchangers start with a temperature equal to the ambient temperature (in the case of non-hull exchangers which have not been initialized, the default temperature is 300K, the Forge-defined temperature of water).

Parameters:

temperature - in degrees Kelvin

getTemperature

double getTemperature()

Get the heat exchanger's current (precise) temperature. This should only be used on the server where precise values are required; it isn't synced to clients by default for performance reasons. Use getTemperatureAsInt() there instead.

Returns:

the temperature

getTemperatureAsInt

int getTemperatureAsInt()

Get the heat exchanger's current temperature to the nearest integer. This is sync'd to clients rather than the precise floating-point temperature to avoid excessive network chatter.

Returns:

the temperature to the nearest integer

getAmbientTemperature

double getAmbientTemperature()

Get the heat exchanger's ambient temperature, i.e. the temperature at which it initially starts, dependent on its environment (biome and altitude).

Returns:

the ambient temperature

setThermalResistance

void setThermalResistance(double thermalResistance)

The higher the thermal resistance, the slower the heat disperses. The effective resistance is the sum of this resistance plus the neighbour's resistance; if both exchangers have a resistance of 1, heat will equalize in a single tick under normal circumstances.

Parameters:

thermalResistance - the thermal resistance; higher resistance means slower heat transfer

getThermalResistance

double getThermalResistance()

Get this heat exchanger's thermal resistance. See setThermalResistance(double) for more information on thermal resistance.

Returns:

the thermal resistance; higher resistance means slower heat transfer

setThermalCapacity

void setThermalCapacity(double capacity)

Set this heat exchanger's thermal capacity.

The higher the capacity, the more heat can be 'stored'. E.g. an object with a heat capacity of double the heat capacity of another object will require twice as much heat gain or loss to adjust the temperature by the same amount.

Parameters:

capacity - the thermal capacity

getThermalCapacity

double getThermalCapacity()

Get this heat exchanger's thermal capacity. See setThermalCapacity(double) for more information.

Returns:

the thermal capacity.

addHeat

void addHeat(double amount)

Adds heat (= deltaT * Thermal Capacity) to this exchanger. Negative values will remove heat.

Parameters:

amount - the heat amount

isSideConnected

boolean isSideConnected(net.minecraft.util.Direction side)

Check if this side of the heat exchanger has a thermal connection of any kind to the neighbouring block in the given direction; whether to another heat exchanger, a static heat source like air, or a custom handler such as a furnace or heat frame. The connection data is initialized in initializeAsHull(World, BlockPos, BiPredicate, Direction...).

Parameters:

side - the side to check

Returns:

true if this side has a thermal connection of any kind

serializeNBT

default net.minecraft.nbt.CompoundNBT serializeNBT()

Specified by:

serializeNBT in interface net.minecraftforge.common.util.INBTSerializable<net.minecraft.nbt.CompoundNBT>

deserializeNBT

default void deserializeNBT(net.minecraft.nbt.CompoundNBT nbt)

Specified by:

deserializeNBT in interface net.minecraftforge.common.util.INBTSerializable<net.minecraft.nbt.CompoundNBT>

getHeatBehaviour

default <T extends HeatBehaviour<?>> java.util.Optional<T> getHeatBehaviour(net.minecraft.util.math.BlockPos pos,
                                                                            java.lang.Class<T> cls)

Get the HeatBehaviour at the given position, which must be adjacent to this heat exchanger's owning tile entity, and in this heat exchanger's list of heat behaviours that it handles.

Type Parameters:

T -

Parameters:

pos - position of the heat behaviour

cls - required class of the heat behaviour (any heat behaviour which extends this class will match)

Returns:

an optional heat behaviour, or Optional.empty() the position is invalid or there is no matching heat behaviour there