Package net.storm.api.movement.pathfinder.model.poh

Enum Class SpiritFairyTree

java.lang.Object
java.lang.Enum<SpiritFairyTree>
net.storm.api.movement.pathfinder.model.poh.SpiritFairyTree
All Implemented Interfaces:
Serializable, Comparable<SpiritFairyTree>, Constable
public enum SpiritFairyTree extends Enum<SpiritFairyTree>
Enumeration of Spirit Tree and Fairy Ring configurations in a Player-Owned House.

SpiritFairyTree represents the different combinations of spirit tree and fairy ring that can be built in the POH superior garden room.

Configuration Options

  • NONE - No spirit tree or fairy ring built
  • FAIRY_RING - Only fairy ring is built
  • SPIRIT_TREE - Only spirit tree is built
  • FAIRY_AND_SPIRIT - Both are built as separate objects
  • SPIRIT_FAIRY_TREE - Combined spirit/fairy tree (highest tier)

Building Requirements

  • Fairy Ring - 85 Construction, Fairytale II started
  • Spirit Tree - 75 Farming, 83 Construction
  • Spirit/Fairy Tree - 83 Farming, 95 Construction

Usage Example


 SpiritFairyTree config = house.getSpiritFairyTree();

 if (config == SpiritFairyTree.SPIRIT_FAIRY_TREE ||
     config == SpiritFairyTree.FAIRY_RING) {
     // Fairy ring is available
 }

 if (config == SpiritFairyTree.SPIRIT_FAIRY_TREE ||
     config == SpiritFairyTree.SPIRIT_TREE) {
     // Spirit tree is available
 }
See Also:

  • Enum Constant Details

    • NONE

      public static final SpiritFairyTree NONE
      No spirit tree or fairy ring is built.

    • FAIRY_RING

      public static final SpiritFairyTree FAIRY_RING
      Only a fairy ring is built.

    • SPIRIT_TREE

      public static final SpiritFairyTree SPIRIT_TREE
      Only a spirit tree is built.

    • FAIRY_AND_SPIRIT

      public static final SpiritFairyTree FAIRY_AND_SPIRIT
      Both fairy ring and spirit tree are built as separate objects.

    • SPIRIT_FAIRY_TREE

      public static final SpiritFairyTree SPIRIT_FAIRY_TREE
      Combined spirit/fairy tree - provides both functions in one object.

  • Method Details

    • values

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