Enum Class Radioactivity

java.lang.Object
java.lang.Enum<Radioactivity>
io.github.thebusybiscuit.slimefun4.core.attributes.Radioactivity
All Implemented Interfaces:
Serializable, Comparable<Radioactivity>, Constable

public enum Radioactivity extends Enum<Radioactivity>
This enum holds all available levels of Radioactivity. The higher the level the more severe the effect of radiation will be.
Author:
TheBusyBiscuit
See Also:
  • Enum Constant Details

    • LOW

      public static final Radioactivity LOW
      This represents a low level of radiation. It will still cause damage but will take a while before it becomes deadly.
    • MODERATE

      public static final Radioactivity MODERATE
      This represents a medium level of radiation. This can be considered the default.
    • HIGH

      public static final Radioactivity HIGH
      This is a high level of radiation. It will cause death if the Player does not act quickly.
    • VERY_HIGH

      public static final Radioactivity VERY_HIGH
      A very high level of radiation will be deadly. The Player should not take this too lightly...
    • VERY_DEADLY

      public static final Radioactivity VERY_DEADLY
      This is the deadliest level of radiation. The Player has basically no chance to protect themselves in time. It will cause certain death.
  • Method Details

    • values

      public static Radioactivity[] 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 Radioactivity 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
    • getExposureModifier

      public int getExposureModifier()
      This method returns the amount of exposure applied to a player every run of the RadiationTask for this radiation level.
      Returns:
      The exposure amount applied per run.
    • getLore

      @Nonnull public String getLore()
    • getRadiationLevel

      public int getRadiationLevel()
      This method returns the level for the radiation effect to use in conjunction with this level of Radioactive. It is basically the index of this enum constant.
      Returns:
      The level of radiation associated with this constant.