Package forestry.api.core

Enum Class ForestryError

java.lang.Object
java.lang.Enum<ForestryError>
forestry.api.core.ForestryError
All Implemented Interfaces:
IError, Serializable, Comparable<ForestryError>, Constable
public enum ForestryError extends Enum<ForestryError> implements IError
All errors used by base Forestry for its blocks and items.

  • Enum Constant Details

  • Method Details

    • values

      public static ForestryError[] 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 ForestryError 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

    • getDescriptionTranslationKey

      public String getDescriptionTranslationKey()
      Specified by:
      getDescriptionTranslationKey in interface IError
      Returns:
      Translation key for a short name that succinctly describes the error. Ex. "Too Hot"

    • getHelpTranslationKey

      public String getHelpTranslationKey()
      Specified by:
      getHelpTranslationKey in interface IError
      Returns:
      Translation key for a detailed message on how to fix the error. Ex. "Move the bees to a cooler climate."

    • getSprite

      public net.minecraft.resources.ResourceLocation getSprite()
      Specified by:
      getSprite in interface IError
      Returns:
      Location of an icon sprite registered to the Forestry texture manager at ITextureManager.

    • getId

      public net.minecraft.resources.ResourceLocation getId()
      Specified by:
      getId in interface IError
      Returns:
      The unique ID for this error.