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

Enum Class PohPool

java.lang.Object
java.lang.Enum<PohPool>
net.storm.api.movement.pathfinder.model.PohPool
All Implemented Interfaces:
Serializable, Comparable<PohPool>, Constable
public enum PohPool extends Enum<PohPool>
Enumeration of Player-Owned House pool types and their restoration effects.

PohPool represents the various restoration pools that can be built in a POH. Each pool type provides different restoration effects and builds upon the previous tier's effects.

Pool Tiers (ascending)

  • ALTAR - Prayer point restoration
  • RESTORATION - Special attack energy to 100%
  • REVITALISATION - Run energy restoration
  • REJUVENATION - Prayer points + run energy
  • FANCY_REJUVENATION - Above + stat restoration (except HP/Prayer)
  • ORNATE_REJUVENATION - Full restoration including HP, poison/venom cure

Usage Logic

A pool is considered "used" when all its effects have been applied. The system checks if each restoration effect is still needed before recommending pool use.

Usage Example


 // Get the highest available pool that still has useful effects
 PohPool pool = PohPool.get();

 if (pool != null) {
     ITileObject poolObject = pool.getObject();
     poolObject.interact("Drink");
 }
See Also:

  • Enum Constant Details

    • ALTAR

      public static final PohPool ALTAR
      Basic altar - restores prayer points only.

    • RESTORATION

      public static final PohPool RESTORATION
      Restoration pool - restores special attack energy to 100%.

    • REVITALISATION

      public static final PohPool REVITALISATION
      Revitalisation pool - restores run energy + restoration pool effects.

    • REJUVENATION

      public static final PohPool REJUVENATION
      Rejuvenation pool - restores prayer points + revitalisation pool effects.

    • FANCY_REJUVENATION

      public static final PohPool FANCY_REJUVENATION
      Fancy rejuvenation pool - restores stats (except HP/Prayer) + rejuvenation effects.

    • ORNATE_REJUVENATION

      public static final PohPool ORNATE_REJUVENATION
      Ornate rejuvenation pool - full restoration including HP, cures poison/venom.

  • Method Details

    • values

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

    • get

      public static PohPool get()
      Gets the highest tier pool available in the current POH that still has useful effects.

      Iterates from highest to lowest tier, returning the first pool that: 1. Has an object present in the house 2. Has not yet been fully used (still has beneficial effects)

      Returns:
      the highest usable pool, or null if not in POH or no pools found

    • isUsed

      public boolean isUsed()
      Checks if this pool's effects have all been applied (no longer useful).

      A pool is considered "used" when:

      • This tier's specific effect is satisfied
      • All previous tier effects are also satisfied
      Returns:
      true if all effects from this pool and lower tiers are fulfilled

    • getObject

      public ITileObject getObject()
      Gets the game object for this pool tier in the current POH.
      Returns:
      the pool object if found, or null if not present