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

Enum Class PortalNexus

java.lang.Object
java.lang.Enum<PortalNexus>
net.storm.api.movement.pathfinder.model.poh.PortalNexus
All Implemented Interfaces:
Serializable, Comparable<PortalNexus>, Constable
public enum PortalNexus extends Enum<PortalNexus>
Enumeration of Portal Nexus destinations and their configuration values.

PortalNexus represents the centralized portal system in a POH that can store multiple teleport destinations in a single object. Each destination is tracked via varbits indicating whether it has been added to the nexus.

Nexus Features

  • Stores up to 30 portal destinations
  • Destinations tracked via individual varbits
  • Supports all standard house portal destinations
  • Handles redirect destinations (Varrock/GE, Camelot/Seers, Watchtower/Yanille)

Redirect Handling

The nexus automatically includes alternate destinations when:

  • Varrock Medium Diary complete - Varrock and Grand Exchange paired
  • Kandarin Hard Diary complete - Camelot and Seers' Village paired
  • Ardougne Hard Diary complete - Watchtower and Yanille paired

Usage Example


 // Get all configured nexus destinations
 Set<PortalNexus> available = PortalNexus.getAvailable();

 // Check if specific destination is available
 if (available.contains(PortalNexus.VARROCK)) {
     HousePortal portal = PortalNexus.VARROCK.getPortal();
     WorldPoint dest = portal.getDestination();
 }
See Also:

  • Enum Constant Details

    • ARCEUUS_LIBRARY

      public static final PortalNexus ARCEUUS_LIBRARY

    • DRAYNOR_MANOR

      public static final PortalNexus DRAYNOR_MANOR

    • BATTLEFRONT

      public static final PortalNexus BATTLEFRONT

    • VARROCK

      public static final PortalNexus VARROCK

    • GRAND_EXCHANGE

      public static final PortalNexus GRAND_EXCHANGE

    • MIND_ALTAR

      public static final PortalNexus MIND_ALTAR

    • LUMBRIDGE

      public static final PortalNexus LUMBRIDGE

    • FALADOR

      public static final PortalNexus FALADOR

    • SALVE_GRAVEYARD

      public static final PortalNexus SALVE_GRAVEYARD

    • CAMELOT

      public static final PortalNexus CAMELOT

    • SEERS_VILLAGE

      public static final PortalNexus SEERS_VILLAGE

    • FENKENSTRAINS_CASTLE

      public static final PortalNexus FENKENSTRAINS_CASTLE

    • EAST_ARDOUGNE

      public static final PortalNexus EAST_ARDOUGNE

    • WATCHTOWER

      public static final PortalNexus WATCHTOWER

    • YANILLE

      public static final PortalNexus YANILLE

    • SENNTISTEN

      public static final PortalNexus SENNTISTEN

    • WEST_ARDOUGNE

      public static final PortalNexus WEST_ARDOUGNE

    • MARIM

      public static final PortalNexus MARIM

    • HARMONY_ISLAND

      public static final PortalNexus HARMONY_ISLAND

    • KHARYRLL

      public static final PortalNexus KHARYRLL

    • LUNAR_ISLE

      public static final PortalNexus LUNAR_ISLE

    • KOUREND

      public static final PortalNexus KOUREND

    • CEMETERY

      public static final PortalNexus CEMETERY

    • WATERBIRTH_ISLAND

      public static final PortalNexus WATERBIRTH_ISLAND

    • BARROWS

      public static final PortalNexus BARROWS

    • CARRALLANGAR

      public static final PortalNexus CARRALLANGAR

    • FISHING_GUILD

      public static final PortalNexus FISHING_GUILD

    • CATHERBY

      public static final PortalNexus CATHERBY

    • ANNAKARL

      public static final PortalNexus ANNAKARL

    • APE_ATOLL_DUNGEON

      public static final PortalNexus APE_ATOLL_DUNGEON

    • GHORROCK

      public static final PortalNexus GHORROCK

    • TROLL_STRONGHOLD

      public static final PortalNexus TROLL_STRONGHOLD

    • WEISS

      public static final PortalNexus WEISS

    • CIVITAS_ILLA_FORTIS

      public static final PortalNexus CIVITAS_ILLA_FORTIS

  • Method Details

    • values

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

    • getAvailable

      public static Set<PortalNexus> getAvailable()
      Gets all portal nexus destinations currently configured in the player's POH.

      Reads the portal slot varbits (6554-6668, 10080-10091) to determine which destinations have been added. Also handles diary-based redirect pairing.

      Returns:
      set of available portal nexus destinations