Package net.storm.api.movement.pathfinder

Interface ITeleportLoader

public interface ITeleportLoader
Interface for loading and building teleport options for pathfinding.

ITeleportLoader is responsible for discovering all available teleport methods based on the player's current inventory, equipment, quest completions, skill levels, and unlocked content. It creates Teleport objects that the pathfinder can use to find optimal routes.

Teleport Categories

  • Jewelry teleports - Ring of Dueling, Games Necklace, Amulet of Glory, etc.
  • Spell teleports - Standard, Ancient, Lunar, and Arceuus spellbooks
  • Item teleports - Teleport tablets, scrolls, and misc items
  • POH teleports - Mounted teleports, jewelry boxes, portal nexus
  • Skill cape teleports - Construction, Crafting, Farming capes, etc.
  • Diary item teleports - Achievement diary rewards
  • Timed teleports - Home teleport, minigame teleports
  • Spirit Trees and Fairy Rings - Network-based transportation

Usage Example


 ITeleportLoader teleportLoader = Static.getTeleportLoader();

 // Build all available teleports
 List<Teleport> teleports = teleportLoader.buildTeleports();

 // Get fairy ring teleports (optionally including POH fairy ring)
 Collection<Teleport> fairyRings = teleportLoader.getFairyRingTeleports(true);

 // Get spirit tree teleports
 Collection<Teleport> spiritTrees = teleportLoader.getSpiritTreeTeleports();
See Also:

  • Method Details

    • getCustomTeleports

      List<Teleport> getCustomTeleports()
      Gets the list of custom teleports registered by plugins or scripts.
      Returns:
      list of custom teleports

    • refreshTeleports

      void refreshTeleports(List<Integer> items)
      Refreshes the available teleports based on current inventory and equipment.
      Parameters:
      items - list of item IDs to consider (for cached lookups)

    • refreshTeleports

      default void refreshTeleports()
      Refreshes the available teleports using current inventory state.

    • buildTeleports

      List<Teleport> buildTeleports(Boolean useCached)
      Builds a list of all currently available teleports.
      Parameters:
      useCached - whether to use cached item data instead of live lookups
      Returns:
      list of available teleports

    • buildTeleports

      default List<Teleport> buildTeleports()
      Builds a list of all currently available teleports using live inventory data.
      Returns:
      list of available teleports

    • buildTimedTeleports

      List<Teleport> buildTimedTeleports()
      Builds teleports that have cooldown timers (home teleport, minigame teleports).
      Returns:
      list of timed teleports that are currently available

    • teleportItems

      List<Teleport> teleportItems(List<Integer> items)
      Gets teleports from various teleport items (tablets, scrolls, misc items).
      Parameters:
      items - list of item IDs in inventory/equipment
      Returns:
      list of available item teleports

    • duelingRing

      List<Teleport> duelingRing(List<Integer> items)
      Gets teleports from Ring of Dueling.
      Parameters:
      items - list of item IDs in inventory/equipment
      Returns:
      list of dueling ring teleports

    • gamesNecklace

      List<Teleport> gamesNecklace(List<Integer> items)
      Gets teleports from Games Necklace.
      Parameters:
      items - list of item IDs in inventory/equipment
      Returns:
      list of games necklace teleports

    • necklaceOfPassage

      List<Teleport> necklaceOfPassage(List<Integer> items)
      Gets teleports from Necklace of Passage.
      Parameters:
      items - list of item IDs in inventory/equipment
      Returns:
      list of passage necklace teleports

    • xericsTalisman

      List<Teleport> xericsTalisman(List<Integer> items)
      Gets teleports from Xeric's Talisman.
      Parameters:
      items - list of item IDs in inventory/equipment
      Returns:
      list of Xeric's talisman teleports

    • digsitePendant

      List<Teleport> digsitePendant(List<Integer> items)
      Gets teleports from Digsite Pendant.
      Parameters:
      items - list of item IDs in inventory/equipment
      Returns:
      list of digsite pendant teleports

    • skillCapes

      List<Teleport> skillCapes(List<Integer> items)
      Gets teleports from skill capes (Construction, Crafting, etc.).
      Parameters:
      items - list of item IDs in inventory/equipment
      Returns:
      list of skill cape teleports

    • kharedstMemoirs

      List<Teleport> kharedstMemoirs(List<Integer> items)
      Gets teleports from Kharedst's Memoirs.
      Parameters:
      items - list of item IDs in inventory/equipment
      Returns:
      list of memoirs teleports

    • diaryItems

      List<Teleport> diaryItems(List<Integer> items)
      Gets teleports from achievement diary reward items.
      Parameters:
      items - list of item IDs in inventory/equipment
      Returns:
      list of diary item teleports

    • ringOfTheElements

      List<Teleport> ringOfTheElements(List<Integer> items)
      Gets teleports from Ring of the Elements.
      Parameters:
      items - list of item IDs in inventory/equipment
      Returns:
      list of Ring of the Elements teleports

    • ringOfShadows

      List<Teleport> ringOfShadows(List<Integer> items)
      Gets teleports from Ring of Shadows.
      Parameters:
      items - list of item IDs in inventory/equipment
      Returns:
      list of Ring of Shadows teleports

    • questItems

      List<Teleport> questItems(List<Integer> items)
      Gets teleports from quest reward items.
      Parameters:
      items - list of item IDs in inventory/equipment
      Returns:
      list of quest item teleports

    • combatBracelet

      List<Teleport> combatBracelet(List<Integer> items)
      Gets teleports from Combat Bracelet.
      Parameters:
      items - list of item IDs in inventory/equipment
      Returns:
      list of combat bracelet teleports

    • skillsNecklace

      List<Teleport> skillsNecklace(List<Integer> items)
      Gets teleports from Skills Necklace.
      Parameters:
      items - list of item IDs in inventory/equipment
      Returns:
      list of skills necklace teleports

    • ringOfWealth

      List<Teleport> ringOfWealth(List<Integer> items)
      Gets teleports from Ring of Wealth.
      Parameters:
      items - list of item IDs in inventory/equipment
      Returns:
      list of ring of wealth teleports

    • amuletOfGlory

      List<Teleport> amuletOfGlory(List<Integer> items)
      Gets teleports from Amulet of Glory.
      Parameters:
      items - list of item IDs in inventory/equipment
      Returns:
      list of glory amulet teleports

    • burningAmulet

      List<Teleport> burningAmulet(List<Integer> items)
      Gets teleports from Burning Amulet.
      Parameters:
      items - list of item IDs in inventory/equipment
      Returns:
      list of burning amulet teleports (Wilderness destinations)

    • slayerRing

      List<Teleport> slayerRing(List<Integer> items)
      Gets teleports from Slayer Ring.
      Parameters:
      items - list of item IDs in inventory/equipment
      Returns:
      list of slayer ring teleports

    • pohMountedTeleports

      List<Teleport> pohMountedTeleports()
      Gets teleports from POH mounted items (digsite pendant, xerics talisman, etc.).
      Returns:
      list of mounted POH teleports

    • pohJewelryBox

      List<Teleport> pohJewelryBox()
      Gets teleports from POH jewelry box.
      Returns:
      list of jewelry box teleports

    • pohPortals

      List<Teleport> pohPortals()
      Gets teleports from POH portal rooms.
      Returns:
      list of portal room teleports

    • pohSpiritFairyTree

      List<Teleport> pohSpiritFairyTree(List<Integer> items)
      Gets teleports from POH spirit tree or fairy ring.
      Parameters:
      items - list of item IDs in inventory/equipment
      Returns:
      list of spirit/fairy tree teleports

    • equipableTeleport

      Teleport equipableTeleport(net.runelite.api.coords.WorldPoint destination, String inventoryAction, String equippedAction, int... itemIds)
      Creates a teleport for an equipable item with different actions for inventory and equipped.
      Parameters:
      destination - the teleport destination
      inventoryAction - the action when item is in inventory
      equippedAction - the action when item is equipped
      itemIds - the item IDs that can perform this teleport
      Returns:
      the created teleport

    • pohPortalTeleport

      Teleport pohPortalTeleport(HousePortal housePortal)
      Creates a teleport for a POH portal room destination.
      Parameters:
      housePortal - the house portal destination
      Returns:
      the created teleport

    • pohNexusTeleport

      Teleport pohNexusTeleport(PortalNexus nexus)
      Creates a teleport for a POH portal nexus destination.
      Parameters:
      nexus - the portal nexus destination
      Returns:
      the created teleport

    • constructionCapeTeleport

      Teleport constructionCapeTeleport(net.runelite.api.coords.WorldPoint destination, String action)
      Creates a teleport using the Construction cape's POH teleport feature.
      Parameters:
      destination - the teleport destination
      action - the action to perform
      Returns:
      the created teleport

    • mountedAdventureTeleport

      Teleport mountedAdventureTeleport(net.runelite.api.coords.WorldPoint destination, String objectName, int action)
      Creates a teleport for a mounted adventure log in POH.
      Parameters:
      destination - the teleport destination
      objectName - the name of the mounted object
      action - the action index to perform
      Returns:
      the created teleport

    • itemTeleport

      Teleport itemTeleport(TeleportItem teleportItem)
      Creates a teleport from a TeleportItem enum value.
      Parameters:
      teleportItem - the teleport item definition
      Returns:
      the created teleport

    • pohWidgetTeleport

      Teleport pohWidgetTeleport(net.runelite.api.coords.WorldPoint destination, char action, String destinationName)
      Creates a teleport using a POH widget-based teleport.
      Parameters:
      destination - the teleport destination
      action - the keyboard shortcut character
      destinationName - the destination name for matching
      Returns:
      the created teleport

    • mountedPohTeleport

      Teleport mountedPohTeleport(net.runelite.api.coords.WorldPoint destination, int objId, String action)
      Creates a teleport for a mounted POH teleport item.
      Parameters:
      destination - the teleport destination
      objId - the object ID of the mounted item
      action - the action to perform
      Returns:
      the created teleport

    • getSpiritTreeTeleports

      Collection<Teleport> getSpiritTreeTeleports(Boolean inPoh)
      Gets all available spirit tree teleports.
      Parameters:
      inPoh - whether to include the POH spirit tree
      Returns:
      collection of spirit tree teleports

    • getSpiritTreeTeleports

      default Collection<Teleport> getSpiritTreeTeleports()
      Gets all available spirit tree teleports, including POH spirit tree.
      Returns:
      collection of spirit tree teleports

    • getFairyRingTeleports

      Collection<Teleport> getFairyRingTeleports(Boolean inPoh)
      Gets all available fairy ring teleports.
      Parameters:
      inPoh - whether to include the POH fairy ring
      Returns:
      collection of fairy ring teleports

    • getFairyRingTeleports

      default Collection<Teleport> getFairyRingTeleports()
      Gets all available fairy ring teleports, including POH fairy ring.
      Returns:
      collection of fairy ring teleports

    • getNexusTeleports

      Map<HousePortal,Teleport> getNexusTeleports()
      Gets a map of portal nexus destinations to their teleport objects.
      Returns:
      map of HousePortal to Teleport for available nexus destinations

    • enterHouse

      void enterHouse()
      Enters the player-owned house using available methods. Attempts to use house teleport tablets, spells, or portals.