forestry.core.climate

Class ClimateManipulator

java.lang.Object

forestry.core.climate.ClimateManipulator

All Implemented Interfaces:

IClimateManipulator

public class ClimateManipulator
extends java.lang.Object
implements IClimateManipulator

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClimateManipulator.Builder

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.

Methods inherited from class java.lang.Object

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

Method Detail

getCurrent

public IClimateState getCurrent()

Specified by:

getCurrent in interface IClimateManipulator

Returns:

The current climate state of this manipulator.

getStart

public IClimateState getStart()

Specified by:

getStart in interface IClimateManipulator

Returns:

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

getTarget

public IClimateState getTarget()

Specified by:

getTarget in interface IClimateManipulator

Returns:

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

allowsBackwards

public boolean allowsBackwards()

Specified by:

allowsBackwards in interface IClimateManipulator

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)).

getDefault

public IClimateState getDefault()

Specified by:

getDefault in interface IClimateManipulator

Returns:

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

getType

public ClimateType getType()

Specified by:

getType in interface IClimateManipulator

Returns:

The type of the climate that this manipulator can manipulate.

finish

public void finish()

Description copied from interface: IClimateManipulator

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

Specified by:

finish in interface IClimateManipulator

addChange

public IClimateState addChange(boolean simulated)

Description copied from interface: IClimateManipulator

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.

Specified by:

addChange in interface IClimateManipulator

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

public IClimateState removeChange(boolean simulated)

Description copied from interface: IClimateManipulator

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.

Specified by:

removeChange in interface IClimateManipulator

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

public boolean canAdd()

Specified by:

canAdd in interface IClimateManipulator

Returns:

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