IClimateTransformer (ForestryMC 5.8.2.427 API)

All Superinterfaces:

ILocatable

All Known Implementing Classes:

ClimateTransformer, FakeClimateTransformer
```
public interface IClimateTransformer
extends ILocatable
```
A transformer modifies the climate in a specific area. To get the climate at a specific position use IWorldClimateHolder.getClimate(long). IClimateTransformer have to be registered with IWorldClimateHolder.updateTransformer(IClimateTransformer) and IWorldClimateHolder.removeTransformer(IClimateTransformer) has to be called after the block that contains the transformer gets harvested / replaced.
IWorldClimateHolder.updateTransformer(IClimateTransformer) has to be called after every change of the climate, the range or the circular state of the transformer.

Method Summary

All Methods Instance Methods Abstract Methods
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()`
`float`	`getCostModifier()`
`IClimateState`	`getCurrent()`
`IClimateState`	`getDefault()`
`IClimateHousing`	`getHousing()`
`int`	`getRange()`
`float`	`getSpeedModifier()`
`IClimateState`	`getTarget()`
`boolean`	`isCircular()`
`void`	`removeTransformer()` Removes the transformer from the world.
`void`	`setCircular(boolean circular)` Sets the circular state of the transformer.
`void`	`setCurrent(IClimateState state)` Sets the current value of the transformer.
`void`	`setRange(int range)` 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.

Methods inherited from interface forestry.api.core.ILocatable
getCoordinates, getWorldObj

- Method Detail
  - update
```
void update()
```
    Updates the transformer and adds it to the world at the first time this method gets called.
  - removeTransformer
```
void removeTransformer()
```
    Removes the transformer from the world. Called at the moment that the block that contains the transformer gets removed / harvested.
  - getHousing
```
IClimateHousing getHousing()
```
    Returns:
    
    The parent of this transformer.
  - getRange
```
int getRange()
```
    Returns:
    
    The range of this transformer in one direction from the center of the transformer.
  - setRange
```
void setRange(int range)
```
    Sets the range of this transformer. The default range of the value is from 1 to 16.
  - setCircular
```
void setCircular(boolean circular)
```
    Sets the circular state of the transformer.
  - isCircular
```
boolean isCircular()
```
    Returns:
    
    True if the current area of the transformer is circular.
  - getArea
```
int getArea()
```
    Returns:
    
    The current area of the transformer in blocks.
  - getAreaModifier
```
float getAreaModifier()
```
    Returns:
    
    A modifier that is calculated with the help of the area size and is used by getCostModifier() and getSpeedModifier() to multiply the cost and the speed based on the size of the area that the transformer transforms.
  - getCostModifier
```
float getCostModifier()
```
    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:
    
    getAreaModifier()
  - getSpeedModifier
```
float getSpeedModifier()
```
    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:
    
    getAreaModifier()
  - getTarget
```
IClimateState getTarget()
```
    Returns:
    
    The targeted state of this transformer.
  - setTarget
```
void setTarget(IClimateState target)
```
    Sets the targeted state of this transformer.
    The state automatically gets clamped between 0.0F and 2.0F and transformed into a immutable IClimateState.
  - getCurrent
```
IClimateState getCurrent()
```
    Returns:
    
    The immutable current state of the transformer.
  - setCurrent
```
void setCurrent(IClimateState state)
```
    Sets the current value of the transformer.
    The state automatically gets clamped between 0.0F and 2.0F and transformed into a immutable IClimateState.
  - getDefault
```
IClimateState getDefault()
```
    Returns:
    
    The immutable IClimateState of the biome in that the transformer is located.
  - createManipulator
```
IClimateManipulatorBuilder createManipulator(ClimateType type)
```
    A helper interface that can be usd to manipulate the state of this logic.
    
    Returns:
    
    A helper interface that can be usd to manipulate the state of this logic.

Interface IClimateTransformer

Method Summary

Methods inherited from interface forestry.api.core.ILocatable

Method Detail

update

removeTransformer

getHousing

getRange

setRange

setCircular

isCircular

getArea

getAreaModifier

getCostModifier

getSpeedModifier

getTarget

setTarget

getCurrent

setCurrent

getDefault

createManipulator