Interface ClimateParameter

All Superinterfaces:
Wrapper
@NullMarked @AsOf("2.3.0") public interface ClimateParameter extends Wrapper
A single climate axis span, wrapping Climate.Parameter.
Since:
2.3.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final double
    MAX_BOUNDARY
     
    static final double
    MIN_BOUNDARY
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static ClimateParameter
    all()
    A span between -2.0 and 2.0.
    static ClimateParameter
    decode(Object minecraftParameter)
    Reads a Minecraft climate parameter.
    double
    max()
    The minimum and maximum values of this parameter between -2.0 and 2.0.
    double
    min()
    The minimum and maximum values of this parameter between -2.0 and 2.0.
    static ClimateParameter
    point(double value)
    A zero width span pinned to one value.
    static ClimateParameter
    span(double min, double max)
    A span between two values.
    static ClimateParameter
    zero()
    A zero width span pinned to zero.

    Methods inherited from interface Wrapper

    asHandle, toMinecraft, unwrap

  • Field Details

  • Method Details

    • min

      @AsOf("2.3.0") double min()
      The minimum and maximum values of this parameter between -2.0 and 2.0.
      Returns:
      the minimum and maximum values of this parameter
      Since:
      2.3.0

    • max

      @AsOf("2.3.0") double max()
      The minimum and maximum values of this parameter between -2.0 and 2.0.
      Returns:
      the minimum and maximum values of this parameter
      Since:
      2.3.0

    • span

      @AsOf("2.3.0") static ClimateParameter span(double min, double max)
      A span between two values.
      Parameters:
      min - the minimum value
      max - the maximum value
      Returns:
      a ClimateParameter between the given values
      Since:
      2.3.0

    • point

      @AsOf("2.3.0") static ClimateParameter point(double value)
      A zero width span pinned to one value.
      Parameters:
      value - the value to pin to
      Returns:
      a ClimateParameter pinned to the given value
      Since:
      2.3.0

    • zero

      @AsOf("2.4.1") static ClimateParameter zero()
      A zero width span pinned to zero.
      Returns:
      a ClimateParameter pinned to zero
      Since:
      2.4.1

    • all

      @AsOf("2.4.1") static ClimateParameter all()
      A span between -2.0 and 2.0.
      Returns:
      a ClimateParameter between -2.0 and 2.0
      Since:
      2.4.1

    • decode

      @AsOf("3.3.0") static ClimateParameter decode(Object minecraftParameter)
      Reads a Minecraft climate parameter.
      Parameters:
      minecraftParameter - the climate parameter to read
      Returns:
      the decoded climate parameter
      Since:
      3.3.0