forestry.core.climate

Class ClimateStateHelper

java.lang.Object

forestry.core.climate.ClimateStateHelper

All Implemented Interfaces:

IClimateStateHelper

public final class ClimateStateHelper
extends java.lang.Object
implements IClimateStateHelper

Field Summary

Fields

Modifier and Type	Field and Description
static float	CLIMATE_CHANGE
static ClimateStateHelper	INSTANCE
static IClimateState	ZERO_STATE

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.
static boolean	isNearTarget(ClimateType type, IClimateState state, IClimateState target)
static boolean	isNearTarget(IClimateState state, IClimateState target)
static boolean	isNearZero(ClimateType type, IClimateState state)
static boolean	isNearZero(IClimateState state)
static boolean	isZero(ClimateType type, IClimateState state)
static boolean	isZero(IClimateState state)
IClimateState	max()
IClimateState	min()
static IClimateState	mutableOf(float temperature, float humidity)
IClimateState	mutableZero()
static IClimateState	of(float temperature, float humidity)
static IClimateState	of(float temperature, float humidity, boolean mutable)
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()

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final ClimateStateHelper INSTANCE

ZERO_STATE

public static final IClimateState ZERO_STATE

CLIMATE_CHANGE

public static final float CLIMATE_CHANGE

See Also:

Constant Field Values

Method Detail

of

public static IClimateState of(float temperature,
                               float humidity,
                               boolean mutable)

of

public static IClimateState of(float temperature,
                               float humidity)

mutableOf

public static IClimateState mutableOf(float temperature,
                                      float humidity)

isNearTarget

public static boolean isNearTarget(IClimateState state,
                                   IClimateState target)

isNearTarget

public static boolean isNearTarget(ClimateType type,
                                   IClimateState state,
                                   IClimateState target)

isZero

public static boolean isZero(IClimateState state)

isNearZero

public static boolean isNearZero(ClimateType type,
                                 IClimateState state)

isZero

public static boolean isZero(ClimateType type,
                             IClimateState state)

isNearZero

public static boolean isNearZero(IClimateState state)

create

public IClimateState create(float temperature,
                            float humidity)

Description copied from interface: IClimateStateHelper

Creates a climate state of the given two climate values.

Specified by:

create in interface IClimateStateHelper

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

public IClimateState create(ClimateType type,
                            float value)

Description copied from interface: IClimateStateHelper

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

Specified by:

create in interface IClimateStateHelper

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

public IClimateState create(IClimateState climateState)

Description copied from interface: IClimateStateHelper

Creates a copy of the given state.

Specified by:

create in interface IClimateStateHelper

Parameters:

climateState - The state that should be copied.

Returns:

A copy of the given state.

create

public IClimateState create(IClimateState climateState,
                            boolean mutable)

Description copied from interface: IClimateStateHelper

Creates a copy of the given state.

Specified by:

create in interface IClimateStateHelper

Parameters:

climateState - The state that should be copied.

mutable - If the copy should be mutable.

Returns:

A copy of the given state.

create

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

Description copied from interface: IClimateStateHelper

Creates a climate state of the given two climate values.

Specified by:

create in interface IClimateStateHelper

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

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

Description copied from interface: IClimateStateHelper

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

Specified by:

create in interface IClimateStateHelper

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.

create

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

Description copied from interface: IClimateStateHelper

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

Specified by:

create in interface IClimateStateHelper

Parameters:

compound - The compound that contains the data.

Returns:

A state that contains the data that the compound contains.

writeToNBT

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

Description copied from interface: IClimateStateHelper

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

Specified by:

writeToNBT in interface IClimateStateHelper

Parameters:

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

state - The state that contains the data.

Returns:

The given compound.

checkState

public IClimateState checkState(IClimateState climateState)

Description copied from interface: IClimateStateHelper

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

Specified by:

checkState in interface IClimateStateHelper

clamp

public IClimateState clamp(IClimateState climateState)

Specified by:

clamp in interface IClimateStateHelper

Returns:

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

absent

public IClimateState absent()

Specified by:

absent in interface IClimateStateHelper

Returns:

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

min

public IClimateState min()

Specified by:

min in interface IClimateStateHelper

Returns:

the minimal values of an immutable IClimateState.

max

public IClimateState max()

Specified by:

max in interface IClimateStateHelper

Returns:

the maximal values of an immutable IClimateState.

zero

public IClimateState zero()

Specified by:

zero in interface IClimateStateHelper

Returns:

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

mutableZero

public IClimateState mutableZero()

Specified by:

mutableZero in interface IClimateStateHelper

Returns:

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