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

Enum Class TeleportScroll

java.lang.Object
java.lang.Enum<TeleportScroll>
net.storm.api.movement.pathfinder.model.TeleportScroll
All Implemented Interfaces:
Serializable, Comparable<TeleportScroll>, Constable
public enum TeleportScroll extends Enum<TeleportScroll>
Enumeration of teleport scrolls obtainable from clue scrolls and the Master Scroll Book.

TeleportScroll defines all teleport scroll types that can be used either individually or stored in the Master Scroll Book. Each scroll provides a one-time teleport to its destination, unless used from the book which consumes one charge instead.

Available Scrolls

  • Desert Region - Nardah, Digsite
  • Remote Areas - Feldip Hills, Lunar Isle, Mort'ton
  • Special Locations - Pest Control, Piscatoris, Mos Le'Harmless
  • Quest-locked - Iorwerth (Regicide), Spider Cave (Priest in Peril)
  • Boss Areas - Key Master (Cerberus), Revenant Cave, Zul-andra
  • Varlamore - Colossal Wyrm, Chasm of Fire

Master Scroll Book Integration

Scrolls can be stored in the Master Scroll Book. When stored:

  • Charges are tracked via varbits
  • Teleports are accessed through the book's interface
  • Widget interactions replace item interactions

Usage Example


 TeleportScroll scroll = TeleportScroll.NARDAH;

 if (scroll.canUse()) {
     scroll.use();
 }
See Also:

  • Enum Constant Details

  • Method Details

    • values

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

    • canUse

      public boolean canUse()
      Checks if this teleport scroll can be used.

      A scroll can be used if the player has the physical scroll in inventory, or has charges stored in the Master Scroll Book. Some scrolls require quest completion.

      Returns:
      true if the scroll can be used, false otherwise

    • use

      public boolean use()
      Uses this teleport scroll.

      Attempts to use the scroll in the following order:

      1. Handle pending confirmation dialogs (Revenant Cave)
      2. Activate via Master Scroll Book widget if open
      3. Use physical scroll from inventory
      4. Open Master Scroll Book if available
      Returns:
      true if an action was taken, false if no scroll/book available