Package forestry.api.climate

Record Class ClimateState

java.lang.Object
java.lang.Record
forestry.api.climate.ClimateState
All Implemented Interfaces:
IClimateProvider
public record ClimateState(TemperatureType temperature, HumidityType humidity) extends Record implements IClimateProvider
Data object for storing a climate's temperature and humidity. Does not change with world updates.

  • Constructor Details

    • ClimateState

      public ClimateState(TemperatureType temperature, HumidityType humidity)
      Creates an instance of a ClimateState record class.
      Parameters:
      temperature - the value for the temperature record component
      humidity - the value for the humidity record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • temperature

      public TemperatureType temperature()
      Returns the value of the temperature record component.
      Specified by:
      temperature in interface IClimateProvider
      Returns:
      the value of the temperature record component

    • humidity

      public HumidityType humidity()
      Returns the value of the humidity record component.
      Specified by:
      humidity in interface IClimateProvider
      Returns:
      the value of the humidity record component