forestry.core.climate

Class ClimateTransformer

java.lang.Object

forestry.core.climate.ClimateTransformer

All Implemented Interfaces:

IClimateTransformer, ILocatable, INbtReadable, INbtWritable, IStreamable

public class ClimateTransformer
extends java.lang.Object
implements IClimateTransformer, IStreamable, INbtReadable, INbtWritable

Field Summary

Fields

Modifier and Type	Field and Description
protected IClimateHousing	housing

Constructor Summary

Constructors

Constructor and Description
ClimateTransformer(IClimateHousing housing)

Method Summary

Modifier and Type	Method and Description
IClimateManipulatorBuilder	createManipulator(ClimateType type) A helper interface that can be usd to manipulate the state of this logic.
int	getArea()
float	getAreaModifier()
net.minecraft.util.math.BlockPos	getCoordinates()
float	getCostModifier()
IClimateState	getCurrent()
IClimateState	getDefault()
IClimateHousing	getHousing()
int	getRange()
float	getSpeedModifier()
IClimateState	getTarget()
net.minecraft.world.World	getWorldObj()
boolean	isCircular()
void	readData(PacketBufferForestry data)
void	readFromNBT(net.minecraft.nbt.NBTTagCompound nbt)
void	removeTransformer() Removes the transformer from the world.
void	setCircular(boolean value) Sets the circular state of the transformer.
void	setCurrent(IClimateState state) Sets the current value of the transformer.
void	setRange(int value) Sets the range of this transformer.
void	setTarget(IClimateState target) Sets the targeted state of this transformer.
void	update() Updates the transformer and adds it to the world at the first time this method gets called.
void	writeData(PacketBufferForestry data)
net.minecraft.nbt.NBTTagCompound	writeToNBT(net.minecraft.nbt.NBTTagCompound nbt)

Methods inherited from class java.lang.Object

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

Field Detail

housing

protected final IClimateHousing housing

Constructor Detail

ClimateTransformer

public ClimateTransformer(IClimateHousing housing)

Method Detail

getHousing

public IClimateHousing getHousing()

Specified by:

getHousing in interface IClimateTransformer

Returns:

The parent of this transformer.

update

public void update()

Description copied from interface: IClimateTransformer

Updates the transformer and adds it to the world at the first time this method gets called.

Specified by:

update in interface IClimateTransformer

removeTransformer

public void removeTransformer()

Description copied from interface: IClimateTransformer

Removes the transformer from the world. Called at the moment that the block that contains the transformer gets removed / harvested.

Specified by:

removeTransformer in interface IClimateTransformer

writeToNBT

public net.minecraft.nbt.NBTTagCompound writeToNBT(net.minecraft.nbt.NBTTagCompound nbt)

Specified by:

writeToNBT in interface INbtWritable

readFromNBT

public void readFromNBT(net.minecraft.nbt.NBTTagCompound nbt)

Specified by:

readFromNBT in interface INbtReadable

createManipulator

public IClimateManipulatorBuilder createManipulator(ClimateType type)

Description copied from interface: IClimateTransformer

A helper interface that can be usd to manipulate the state of this logic.

Specified by:

createManipulator in interface IClimateTransformer

Returns:

A helper interface that can be usd to manipulate the state of this logic.

writeData

public void writeData(PacketBufferForestry data)

Specified by:

writeData in interface IStreamable

readData

public void readData(PacketBufferForestry data)
              throws java.io.IOException

Specified by:

readData in interface IStreamable

Throws:

java.io.IOException

getCurrent

public IClimateState getCurrent()

Specified by:

getCurrent in interface IClimateTransformer

Returns:

The immutable current state of the transformer.

setCurrent

public void setCurrent(IClimateState state)

Description copied from interface: IClimateTransformer

Sets the current value of the transformer.

The state automatically gets clamped between 0.0F and 2.0F and transformed into a immutable IClimateState.

Specified by:

setCurrent in interface IClimateTransformer

getTarget

public IClimateState getTarget()

Specified by:

getTarget in interface IClimateTransformer

Returns:

The targeted state of this transformer.

setTarget

public void setTarget(IClimateState target)

Description copied from interface: IClimateTransformer

Sets the targeted state of this transformer.

The state automatically gets clamped between 0.0F and 2.0F and transformed into a immutable IClimateState.

Specified by:

setTarget in interface IClimateTransformer

getDefault

public IClimateState getDefault()

Specified by:

getDefault in interface IClimateTransformer

Returns:

The immutable IClimateState of the biome in that the transformer is located.

setCircular

public void setCircular(boolean value)

Description copied from interface: IClimateTransformer

Sets the circular state of the transformer.

Specified by:

setCircular in interface IClimateTransformer

isCircular

public boolean isCircular()

Specified by:

isCircular in interface IClimateTransformer

Returns:

True if the current area of the transformer is circular.

setRange

public void setRange(int value)

Description copied from interface: IClimateTransformer

Sets the range of this transformer. The default range of the value is from 1 to 16.

Specified by:

setRange in interface IClimateTransformer

getAreaModifier

public float getAreaModifier()

Specified by:

getAreaModifier in interface IClimateTransformer

Returns:

A modifier that is calculated with the help of the area size and is used by IClimateTransformer.getCostModifier() and IClimateTransformer.getSpeedModifier() to multiply the cost and the speed based on the size of the area that the transformer transforms.

getCostModifier

public float getCostModifier()

Specified by:

getCostModifier in interface IClimateTransformer

Returns:

A modifier that gets used to scale the cost of the habitat former based on the size of the area it transforms.

See Also:

IClimateTransformer.getAreaModifier()

getSpeedModifier

public float getSpeedModifier()

Specified by:

getSpeedModifier in interface IClimateTransformer

Returns:

A modifier that gets used to scale the speed of the habitat former based on the size of the area it transforms.

See Also:

IClimateTransformer.getAreaModifier()

getArea

public int getArea()

Specified by:

getArea in interface IClimateTransformer

Returns:

The current area of the transformer in blocks.

getRange

public int getRange()

Specified by:

getRange in interface IClimateTransformer

Returns:

The range of this transformer in one direction from the center of the transformer.

getCoordinates

public net.minecraft.util.math.BlockPos getCoordinates()

Specified by:

getCoordinates in interface ILocatable

getWorldObj

public net.minecraft.world.World getWorldObj()

Specified by:

getWorldObj in interface ILocatable