Package com.github.thedeathlycow.thermoo.api.temperature

Enum Class HeatingModes

java.lang.Object
java.lang.Enum<HeatingModes>
com.github.thedeathlycow.thermoo.api.temperature.HeatingModes
All Implemented Interfaces:
HeatingMode, Serializable, Comparable<HeatingModes>, Constable, net.minecraft.util.StringRepresentable
public enum HeatingModes extends Enum<HeatingModes> implements HeatingMode, net.minecraft.util.StringRepresentable
The three primary modes for adding and removing heat from a TemperatureAware.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

    Nested classes/interfaces inherited from interface net.minecraft.util.StringRepresentable

    net.minecraft.util.StringRepresentable.EnumCodec<E extends Enum<E> & net.minecraft.util.StringRepresentable>, net.minecraft.util.StringRepresentable.StringRepresentableCodec<S extends net.minecraft.util.StringRepresentable>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ABSOLUTE
    Applies temperature changes absolutely - ignoring all resistance in all conditions.
    ACTIVE
    Always applies the relevant resistance for the change - cold resistance when the change is negative (decreasing temperature) and heat resistance when the change is positive (increasing temperature).
    PASSIVE
    Only applies thermal resistance when the target is currently in the relevant temperature range.

  • Field Summary

    Fields inherited from interface net.minecraft.util.StringRepresentable

    PRE_BUILT_MAP_THRESHOLD

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getSerializedName()
     
    static HeatingModes
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static HeatingModes[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.github.thedeathlycow.thermoo.api.temperature.HeatingMode

    applyResistance

  • Enum Constant Details

    • ABSOLUTE

      public static final HeatingModes ABSOLUTE
      Applies temperature changes absolutely - ignoring all resistance in all conditions. Used as the default mode in commands or other debug environments.

    • ACTIVE

      public static final HeatingModes ACTIVE
      Always applies the relevant resistance for the change - cold resistance when the change is negative (decreasing temperature) and heat resistance when the change is positive (increasing temperature).

      Used for non-environmental effects, like a Frostologer freezing their victim or an Enchantment that drains heat.

    • PASSIVE

      public static final HeatingModes PASSIVE
      Only applies thermal resistance when the target is currently in the relevant temperature range. For example, cold resistance is only applied to targets that are cold; and heat resistance only to targets that are warm.

      Used for passive effects, such as the temperature change of standing on ice or being near to a torch. This is not used for the environment temperature in ServerPlayerEnvironmentTickEvents.

  • Method Details

    • values

      public static HeatingModes[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static HeatingModes valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getSerializedName

      public String getSerializedName()
      Specified by:
      getSerializedName in interface net.minecraft.util.StringRepresentable