IClimateState (ForestryMC 5.8.2.427 API)

All Known Implementing Classes:

AbsentClimateState
```
public interface IClimateState
```
A IClimateState is used to store and handle temperature and humidity.
The values are oriented on the values of Biome.getDefaultTemperature() and Biome.getRainfall().
If any of the two values would be Float.NAN after an operation IClimateStateHelper.absent() will be returned instead of the state.
IClimateStateHelper at ClimateManager.stateHelper provides some helper methods to create and handle climate states.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default IClimateState`	`add(ClimateType type, float value)` Adds the given value to the value of this state.
`IClimateState`	`add(IClimateState state)` Adds the given state to this state.
`IClimateState`	`addHumidity(float humidity)` Adds the given value to the humidity value of this state.
`IClimateState`	`addTemperature(float temperature)` Adds the given value to the temperature value of this state.
`IClimateState`	`copy()`
`IClimateState`	`copy(boolean mutable)`
`default float`	`getClimate(ClimateType type)`
`float`	`getHumidity()`
`default EnumHumidity`	`getHumidityEnum()`
`float`	`getTemperature()`
`default EnumTemperature`	`getTemperatureEnum()`
`boolean`	`isClamped()`
`boolean`	`isMutable()`
`boolean`	`isPresent()`
`IClimateState`	`map(java.util.function.Function<java.lang.Float,java.lang.Float> mapper)` Applies the mapper `Function.apply(Object)` on the two climate values of this state.
`IClimateState`	`multiply(double factor)` Multiplies the values of this state with the given factor.
`default IClimateState`	`setClimate(ClimateType type, float value)` Adds climate value of this state.
`IClimateState`	`setClimate(float temperature, float humidity)` Sets the humidity and temperature value to the given values.
`IClimateState`	`setHumidity(float humidity)` Sets the humidity value of this state.
`IClimateState`	`setTemperature(float temperature)` Sets the temperature value of this state.
`default IClimateState`	`subtract(ClimateType type, float value)` Subtracts the given value from the value of this state.
`IClimateState`	`subtract(IClimateState state)` Subtracts the given state from this state.
`default IClimateState`	`subtractHumidity(float value)` Subtracts the given value from the humidity value of this state.
`default IClimateState`	`subtractTemperature(float value)` Subtracts the given value from the temperature value of this state.
`IClimateState`	`toImmutable()`
`IClimateState`	`toMutable()`

- Method Detail
  - getTemperature
```
float getTemperature()
```
    Returns:
    
    Returns the exact temperature value of this climate state.
  - getTemperatureEnum
```
default EnumTemperature getTemperatureEnum()
```
    Returns:
    
    Returns the enum temperature value of this climate state.
  - getHumidity
```
float getHumidity()
```
    Returns:
    
    Returns the exact humidity value of this climate state.
  - getHumidityEnum
```
default EnumHumidity getHumidityEnum()
```
    Returns:
    
    Returns the enum humidity value of this climate state.
  - getClimate
```
default float getClimate(ClimateType type)
```
    Returns:
    
    Returns the climate value of the given type.
  - addTemperature
```
IClimateState addTemperature(float temperature)
```
    Adds the given value to the temperature value of this state.
    
    Returns:
    
    The absent state if any of the two climate values would be Float.NAN otherwise if this state is isMutable() this state or if it isn't a immutable copy of the state with the new values.
  - addHumidity
```
IClimateState addHumidity(float humidity)
```
    Adds the given value to the humidity value of this state.
    
    Returns:
    
    The absent state if any of the two climate values would be Float.NAN otherwise if this state is isMutable() this state or if it isn't a immutable copy of the state with the new values.
  - add
```
IClimateState add(IClimateState state)
```
    Adds the given state to this state.
    
    Returns:
    
    The absent state if any of the two climate values would be Float.NAN otherwise if this state is isMutable() this state or if it isn't a immutable copy of the state with the new values.
  - add
```
default IClimateState add(ClimateType type,
                          float value)
```
    Adds the given value to the value of this state.
    
    Returns:
    
    The absent state if any of the two climate values would be Float.NAN otherwise if this state is isMutable() this state or if it isn't a immutable copy of the state with the new values.
  - setTemperature
```
IClimateState setTemperature(float temperature)
```
    Sets the temperature value of this state.
    
    Returns:
    
    The absent state if any of the two climate values would be Float.NAN otherwise if this state is isMutable() this state or if it isn't a immutable copy of the state with the new values.
  - setHumidity
```
IClimateState setHumidity(float humidity)
```
    Sets the humidity value of this state.
    
    Returns:
    
    The absent state if any of the two climate values would be Float.NAN otherwise if this state is isMutable() this state or if it isn't a immutable copy of the state with the new values.
  - setClimate
```
IClimateState setClimate(float temperature,
                         float humidity)
```
    Sets the humidity and temperature value to the given values.
    
    Returns:
    
    The absent state if any of the two climate values would be Float.NAN otherwise if this state is isMutable() this state or if it isn't a immutable copy of the state with the new values.
  - setClimate
```
default IClimateState setClimate(ClimateType type,
                                 float value)
```
    Adds climate value of this state.
    
    Returns:
    
    The absent state if any of the two climate values would be Float.NAN otherwise if this state is isMutable() this state or if it isn't a immutable copy of the state with the new values.
  - multiply
```
IClimateState multiply(double factor)
```
    Multiplies the values of this state with the given factor.
    
    Returns:
    
    The absent state if any of the two climate values would be Float.NAN otherwise if this state is isMutable() this state or if it isn't a immutable copy of the state with the new values.
  - subtractTemperature
```
default IClimateState subtractTemperature(float value)
```
    Subtracts the given value from the temperature value of this state.
    
    Returns:
    
    The absent state if any of the two climate values would be Float.NAN otherwise if this state is isMutable() this state or if it isn't a immutable copy of the state with the new values.
  - subtractHumidity
```
default IClimateState subtractHumidity(float value)
```
    Subtracts the given value from the humidity value of this state.
    
    Returns:
    
    The absent state if any of the two climate values would be Float.NAN otherwise if this state is isMutable() this state or if it isn't a immutable copy of the state with the new values.
  - subtract
```
IClimateState subtract(IClimateState state)
```
    Subtracts the given state from this state.
    
    Returns:
    
    The absent state if any of the two climate values would be Float.NAN otherwise if this state is isMutable() this state or if it isn't a immutable copy of the state with the new values.
  - subtract
```
default IClimateState subtract(ClimateType type,
                               float value)
```
    Subtracts the given value from the value of this state.
    
    Returns:
    
    The absent state if any of the two climate values would be Float.NAN otherwise if this state is isMutable() this state or if it isn't a immutable copy of the state with the new values.
  - map
```
IClimateState map(java.util.function.Function<java.lang.Float,java.lang.Float> mapper)
```
    Applies the mapper Function.apply(Object) on the two climate values of this state.
    
    Returns:
    
    The absent state if any of the two climate values would be Float.NAN otherwise if this state is isMutable() this state or if it isn't a immutable copy of the state with the new values.
  - copy
```
IClimateState copy(boolean mutable)
```
    Parameters:
    
    mutable - If the copy of this state should be mutable or immutable.
    
    Returns:
    
    The copy of this state.
  - copy
```
IClimateState copy()
```
    Returns:
    
    The copy of this state if isMutable() of this state is true or returns the immutable state.
  - toMutable
```
IClimateState toMutable()
```
    Returns:
    
    A mutable copy of this state if the state is immutable and the state itself if the state is mutable.
  - toImmutable
```
IClimateState toImmutable()
```
    Returns:
    
    A immutable copy of this state of the state is mutable and the state itself if the state is immutable.
  - isPresent
```
boolean isPresent()
```
    Returns:
    
    If any of the two climate values of this state is Float.NAN.
  - isMutable
```
boolean isMutable()
```
    Returns:
    
    If the state is mutable.
  - isClamped
```
boolean isClamped()
```
    Returns:
    
    If the two values of this state are between 0 and 2.0.
    
    See Also:
    
    IClimateStateHelper.clamp(IClimateState)

Interface IClimateState

Method Summary

Method Detail

getTemperature

getTemperatureEnum

getHumidity

getHumidityEnum

getClimate

addTemperature

addHumidity

add

add

setTemperature

setHumidity

setClimate

setClimate

multiply

subtractTemperature

subtractHumidity

subtract

subtract

map

copy

copy

toMutable

toImmutable

isPresent

isMutable

isClamped