forestry.api.climate

Interface IClimateManipulator

All Known Implementing Classes:

ClimateManipulator

public interface IClimateManipulator

The climate manipulator can be used to manipulate the climate of an IClimateTransformer.

Method Summary

Modifier and Type	Method and Description
IClimateState	addChange(boolean simulated) Tries to add the change value to the current state of this transformer.
boolean	allowsBackwards()
boolean	canAdd()
void	finish() Calls the Consumer that was set with IClimateManipulatorBuilder.setOnFinish(Consumer).
IClimateState	getCurrent()
IClimateState	getDefault()
IClimateState	getStart()
IClimateState	getTarget()
ClimateType	getType()
IClimateState	removeChange(boolean simulated) Tries to remove the change value from the current state of this transformer.

Method Detail

getCurrent

IClimateState getCurrent()

Returns:

The current climate state of this manipulator.

getStart

IClimateState getStart()

Returns:

The climate state that was set with IClimateManipulatorBuilder.setCurrent(IClimateState).

getTarget

IClimateState getTarget()

Returns:

The targeted state of this manipulator and was set with IClimateManipulatorBuilder.setTarget(IClimateState).

getDefault

IClimateState getDefault()

Returns:

The default state of this manipulator and was set with IClimateManipulatorBuilder.setDefault(IClimateState) (IClimateState)}.

allowsBackwards

boolean allowsBackwards()

Returns:

If the manipulator is allowed to go into the opposite direction. (to negate the change value that was supplied by the Function that as set with IClimateManipulatorBuilder.setChangeSupplier(BiFunction)).

getType

ClimateType getType()

Returns:

The type of the climate that this manipulator can manipulate.

addChange

IClimateState addChange(boolean simulated)

Tries to add the change value to the current state of this transformer. Automatically rounds if the new state would be near the targeted state.

Parameters:

simulated - If the add should only be simulated.

Returns:

The difference between the new current state and the current state before the change was added. Both values are zero if nothing was / would have been added.

removeChange

IClimateState removeChange(boolean simulated)

Tries to remove the change value from the current state of this transformer. Automatically rounds if the new state would be near the default state.

Parameters:

simulated - If the remove should only be simulated.

Returns:

The difference between the new current state and the current state before the change was removed. Both values are zero if nothing was / would have been removed.

canAdd

boolean canAdd()

Returns:

If the change value has the right sign to bring the current climate state closer to the targeted state.

finish

void finish()

Calls the Consumer that was set with IClimateManipulatorBuilder.setOnFinish(Consumer).