me.desht.pneumaticcraft.common.heat

Class HeatExchangerLogicTicking

java.lang.Object

me.desht.pneumaticcraft.common.heat.HeatExchangerLogicTicking

All Implemented Interfaces:

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

public class HeatExchangerLogicTicking
extends java.lang.Object
implements IHeatExchangerLogic

Field Summary

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

ALL_BLOCKS

Constructor Summary

Constructors

Constructor and Description
HeatExchangerLogicTicking()

Method Summary

Modifier and Type	Method and Description
void	addConnectedExchanger(IHeatExchangerLogic exchanger, boolean reciprocate)
void	addHeat(double amount) Adds heat (= deltaT * Thermal Capacity) to this exchanger.
void	deserializeNBT(net.minecraft.nbt.CompoundNBT nbt)
static void	exchange(IHeatExchangerLogic logic, IHeatExchangerLogic logic2)
double	getAmbientTemperature() Get the heat exchanger's ambient temperature, i.e.
<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.
void	removeConnectedExchanger(IHeatExchangerLogic exchanger, boolean reciprocate)
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

addConnectedExchanger, removeConnectedExchanger

Constructor Detail

HeatExchangerLogicTicking

public HeatExchangerLogicTicking()

Method Detail

initializeAsHull

public 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

isSideConnected

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

Description copied from interface: IHeatExchangerLogic

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

Specified by:

isSideConnected in interface IHeatExchangerLogic

Parameters:

side - the side to check

Returns:

true if this side has a thermal connection of any kind

addConnectedExchanger

public void addConnectedExchanger(IHeatExchangerLogic exchanger,
                                  boolean reciprocate)

Specified by:

addConnectedExchanger in interface IHeatExchangerLogic

Parameters:

exchanger - the other heat exchanger

reciprocate - whether the other exchanger should also add this one

removeConnectedExchanger

public void removeConnectedExchanger(IHeatExchangerLogic exchanger,
                                     boolean reciprocate)

Specified by:

removeConnectedExchanger in interface IHeatExchangerLogic

Parameters:

exchanger - the other heat exchanger

reciprocate - whether the other exchanger should also add this one

initializeAmbientTemperature

public 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

getTemperature

public double getTemperature()

Description copied from interface: IHeatExchangerLogic

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 IHeatExchangerLogic.getTemperatureAsInt() there instead.

Specified by:

getTemperature in interface IHeatExchangerLogic

Returns:

the temperature

getTemperatureAsInt

public 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

setTemperature

public 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

setThermalResistance

public 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

getThermalResistance

public double getThermalResistance()

Description copied from interface: IHeatExchangerLogic

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

Specified by:

getThermalResistance in interface IHeatExchangerLogic

Returns:

the thermal resistance; higher resistance means slower heat transfer

setThermalCapacity

public 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

getThermalCapacity

public double getThermalCapacity()

Description copied from interface: IHeatExchangerLogic

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

Specified by:

getThermalCapacity in interface IHeatExchangerLogic

Returns:

the thermal capacity.

serializeNBT

public net.minecraft.nbt.CompoundNBT serializeNBT()

Specified by:

serializeNBT in interface IHeatExchangerLogic

Specified by:

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

deserializeNBT

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

Specified by:

deserializeNBT in interface IHeatExchangerLogic

Specified by:

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

tick

public 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

getAmbientTemperature

public double getAmbientTemperature()

Description copied from interface: IHeatExchangerLogic

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

Specified by:

getAmbientTemperature in interface IHeatExchangerLogic

Returns:

the ambient temperature

exchange

public static void exchange(IHeatExchangerLogic logic,
                            IHeatExchangerLogic logic2)

addHeat

public void addHeat(double amount)

Description copied from interface: IHeatExchangerLogic

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

Specified by:

addHeat in interface IHeatExchangerLogic

Parameters:

amount - the heat amount

getHeatBehaviour

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

Description copied from interface: IHeatExchangerLogic

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.

Specified by:

getHeatBehaviour in interface IHeatExchangerLogic

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