forestry.api.climate

Interface IClimateStateHelper

All Known Implementing Classes:

ClimateStateHelper

public interface IClimateStateHelper

Contains methods to create IClimateStates or to get constant and immutable IClimateStates like zero(), min(), max() or absent().

Method Summary

Modifier and Type	Method and Description
IClimateState	absent()
IClimateState	checkState(IClimateState climateState) Checks if the given state is valid and returns the absent state if the given state is not valid.
IClimateState	clamp(IClimateState climateState)
IClimateState	create(ClimateType type, float value) Creates a state that contains the given value of the given type and 0.0F as the value of the other type.
IClimateState	create(float temperature, float humidity) Creates a climate state of the given two climate values.
IClimateState	create(float temperature, float humidity, boolean mutable) Creates a climate state of the given two climate values.
IClimateState	create(IClimateState climateState) Creates a copy of the given state.
IClimateState	create(IClimateState climateState, boolean mutable) Creates a copy of the given state.
IClimateState	create(net.minecraft.nbt.NBTTagCompound compound) Creates a state based on the data that the given compound contains.
IClimateState	create(net.minecraft.nbt.NBTTagCompound compound, boolean mutable) Creates a state based on the data that the given compound contains.
IClimateState	max()
IClimateState	min()
IClimateState	mutableZero()
net.minecraft.nbt.NBTTagCompound	writeToNBT(net.minecraft.nbt.NBTTagCompound compound, IClimateState state) Writes the data of the given state to the given compound.
IClimateState	zero()

Method Detail

create

IClimateState create(float temperature,
                     float humidity)

Creates a climate state of the given two climate values.

Parameters:

temperature - The temperature value of the new state.

humidity - The humidity value of the new state.

Returns:

A newly created state that contains the given values.

create

IClimateState create(float temperature,
                     float humidity,
                     boolean mutable)

Creates a climate state of the given two climate values.

Parameters:

temperature - The temperature value of the new state.

humidity - The humidity value of the new state.

mutable - If the new state should be mutable.

Returns:

A newly created state that contains the given values.

create

IClimateState create(IClimateState climateState)

Creates a copy of the given state.

Parameters:

climateState - The state that should be copied.

Returns:

A copy of the given state.

create

IClimateState create(IClimateState climateState,
                     boolean mutable)

Creates a copy of the given state.

Parameters:

climateState - The state that should be copied.

mutable - If the copy should be mutable.

Returns:

A copy of the given state.

create

IClimateState create(ClimateType type,
                     float value)

Creates a state that contains the given value of the given type and 0.0F as the value of the other type.

Parameters:

type - The type of the given value.

value - The value of the given type.

Returns:

A state that contains the given value of the given type and 0.0F as the value of the other type.

create

IClimateState create(net.minecraft.nbt.NBTTagCompound compound)

Creates a state based on the data that the given compound contains.

Parameters:

compound - The compound that contains the data.

Returns:

A state that contains the data that the compound contains.

create

IClimateState create(net.minecraft.nbt.NBTTagCompound compound,
                     boolean mutable)

Creates a state based on the data that the given compound contains.

Parameters:

compound - The compound that contains the data.

mutable - If the copy should be mutable.

Returns:

A state that contains the data that the compound contains.

writeToNBT

net.minecraft.nbt.NBTTagCompound writeToNBT(net.minecraft.nbt.NBTTagCompound compound,
                                            IClimateState state)

Writes the data of the given state to the given compound.

Parameters:

compound - The compound that the data will be writen to.

state - The state that contains the data.

Returns:

The given compound.

checkState

IClimateState checkState(IClimateState climateState)

Checks if the given state is valid and returns the absent state if the given state is not valid.

clamp

IClimateState clamp(IClimateState climateState)

Returns:

Clamps the values of the given state between 0.0F and 2.0F.

absent

IClimateState absent()

Returns:

The absent climate state. Both values of the absent state are Float.NAN.

min

IClimateState min()

Returns:

the minimal values of an immutable IClimateState.

max

IClimateState max()

Returns:

the maximal values of an immutable IClimateState.

zero

IClimateState zero()

Returns:

a immutable climate state of which both IClimateState.getHumidity() and IClimateState.getTemperature() are zero.

mutableZero

IClimateState mutableZero()

Returns:

a mutable climate state of which both IClimateState.getHumidity() and IClimateState.getTemperature() are zero.