me.desht.pneumaticcraft.api.heat

Interface IHeatExchangerAdapter

All Superinterfaces:

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

All Known Implementing Classes:

IHeatExchangerAdapter.Simple, Mek2PNCHeatProvider.Mek2PNCHeatAdapter

public interface IHeatExchangerAdapter
extends IHeatExchangerLogic

A special extension of IHeatExchangerLogic intended for implementing adapter objects for other mods' heat systems. An implementation of this can be attached to other mods' tile entities to make them appear like PNC heat exchanging blocks, while internally adapting the PNC heat API to the block's actual heat API.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IHeatExchangerAdapter.Simple<CAP> Convenience adapter implementation which can be extended.

Field Summary

Fields inherited from interface me.desht.pneumaticcraft.api.heat.IHeatExchangerLogic

ALL_BLOCKS

Method Summary

Modifier and Type	Method and Description
default int	getTemperatureAsInt() Get the heat exchanger's current temperature to the nearest integer.
default 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.
default 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.
default void	setTemperature(double temperature) Set the temperature of this heat exchanger.
default void	setThermalCapacity(double capacity) Set this heat exchanger's thermal capacity.
default void	setThermalResistance(double thermalResistance) The higher the thermal resistance, the slower the heat disperses.
default void	tick() Call this to tick this logic, and make the heat disperse itself.

Methods inherited from interface me.desht.pneumaticcraft.api.heat.IHeatExchangerLogic

addConnectedExchanger, addConnectedExchanger, addHeat, deserializeNBT, getAmbientTemperature, getHeatBehaviour, getTemperature, getThermalCapacity, getThermalResistance, isSideConnected, removeConnectedExchanger, removeConnectedExchanger, serializeNBT

Method Detail

tick

default void tick()

Description copied from interface: IHeatExchangerLogic

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.

Specified by:

tick in interface IHeatExchangerLogic

initializeAsHull

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

Description copied from interface: IHeatExchangerLogic

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

Specified by:

initializeAsHull in interface IHeatExchangerLogic

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

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

Description copied from interface: IHeatExchangerLogic

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 IHeatExchangerLogic.initializeAsHull(World, BlockPos, BiPredicate, Direction...)

Specified by:

initializeAmbientTemperature in interface IHeatExchangerLogic

Parameters:

world - the world

pos - the position

setTemperature

default void setTemperature(double temperature)

Description copied from interface: IHeatExchangerLogic

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

Specified by:

setTemperature in interface IHeatExchangerLogic

Parameters:

temperature - in degrees Kelvin

getTemperatureAsInt

default int getTemperatureAsInt()

Description copied from interface: IHeatExchangerLogic

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.

Specified by:

getTemperatureAsInt in interface IHeatExchangerLogic

Returns:

the temperature to the nearest integer

setThermalResistance

default void setThermalResistance(double thermalResistance)

Description copied from interface: IHeatExchangerLogic

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.

Specified by:

setThermalResistance in interface IHeatExchangerLogic

Parameters:

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

setThermalCapacity

default void setThermalCapacity(double capacity)

Description copied from interface: IHeatExchangerLogic

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.

Specified by:

setThermalCapacity in interface IHeatExchangerLogic

Parameters:

capacity - the thermal capacity