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

Enum Class BankLocation

java.lang.Object
java.lang.Enum<BankLocation>
net.storm.api.movement.pathfinder.model.BankLocation
All Implemented Interfaces:
Serializable, Comparable<BankLocation>, Constable
public enum BankLocation extends Enum<BankLocation>
Enumeration of all bank locations throughout the game world.

BankLocation provides a comprehensive list of all accessible bank areas in Old School RuneScape, including their world area bounds and any requirements needed to access them.

Bank Categories

  • Free-to-play Banks - Lumbridge, Varrock, Falador, etc.
  • Member Banks - Catherby, Seers Village, Ardougne, etc.
  • Quest-locked Banks - Burgh de Rott, Darkmeyer, Lletya, etc.
  • Skill-locked Banks - Crafting Guild, Mining Guild, etc.
  • Regional Banks - Kourend, Varlamore, Fossil Island, etc.

Requirements

Bank locations can have various requirements:

  • Quest completion (e.g., Priest in Peril for Canifis)
  • Skill levels (e.g., 60 Mining for Mining Guild)
  • Region visitation (e.g., visiting Kourend/Varlamore)
  • Diary completion (e.g., for certain teleport destinations)

Usage Example


 // Find nearest bank
 BankLocation nearest = BankLocation.getNearest();

 // Find nearest bank considering path distance and teleports
 BankLocation nearestPath = BankLocation.getNearestPath(true);

 // Check if a specific bank is accessible
 if (BankLocation.GRAND_EXCHANGE_BANK.canUse()) {
     // Walk to GE bank
 }
See Also:

  • Enum Constant Details

    • ALCHEMICAL_SOCIETY

      public static final BankLocation ALCHEMICAL_SOCIETY

    • AL_KHARID_BANK

      public static final BankLocation AL_KHARID_BANK

    • ALDARIN_BANK

      public static final BankLocation ALDARIN_BANK

    • ARCEUUS_BANK

      public static final BankLocation ARCEUUS_BANK

    • ARDOUGNE_NORTH_BANK

      public static final BankLocation ARDOUGNE_NORTH_BANK

    • ARDOUGNE_SOUTH_BANK

      public static final BankLocation ARDOUGNE_SOUTH_BANK

    • AUBURNVALE

      public static final BankLocation AUBURNVALE

    • BARBARIAN_OUTPOST_BANK

      public static final BankLocation BARBARIAN_OUTPOST_BANK

    • BLAST_FURNACE

      public static final BankLocation BLAST_FURNACE

    • BURGH_DE_ROTT_BANK

      public static final BankLocation BURGH_DE_ROTT_BANK

    • CAM_TORUM

      public static final BankLocation CAM_TORUM

    • CANIFIS_BANK

      public static final BankLocation CANIFIS_BANK

    • CASTLE_WARS_BANK

      public static final BankLocation CASTLE_WARS_BANK

    • CATHERBY_BANK

      public static final BankLocation CATHERBY_BANK

    • CHAMBERS_OF_XERIC

      public static final BankLocation CHAMBERS_OF_XERIC

    • CHARCOAL_BURNERS_BANK

      public static final BankLocation CHARCOAL_BURNERS_BANK

    • CIVITAS_EAST

      public static final BankLocation CIVITAS_EAST

    • CIVITAS_WEST

      public static final BankLocation CIVITAS_WEST

    • COLOSSEUM

      public static final BankLocation COLOSSEUM

    • CORSAIR_COVE_BANK

      public static final BankLocation CORSAIR_COVE_BANK

    • CRAFTING_GUILD

      public static final BankLocation CRAFTING_GUILD

    • DARKFROST

      public static final BankLocation DARKFROST

    • DARKMEYER_BANK

      public static final BankLocation DARKMEYER_BANK

    • DEEPFIN_WEST

      public static final BankLocation DEEPFIN_WEST

    • DEEPFIN_EAST

      public static final BankLocation DEEPFIN_EAST

    • DRAYNOR_BANK

      public static final BankLocation DRAYNOR_BANK

    • DUEL_ARENA_BANK

      public static final BankLocation DUEL_ARENA_BANK

    • EDGEVILLE_BANK

      public static final BankLocation EDGEVILLE_BANK

    • ETCETERIA_BANK

      public static final BankLocation ETCETERIA_BANK

    • FALADOR_EAST_BANK

      public static final BankLocation FALADOR_EAST_BANK

    • FALADOR_WEST_BANK

      public static final BankLocation FALADOR_WEST_BANK

    • FARMING_GUILD_NORTH

      public static final BankLocation FARMING_GUILD_NORTH

    • FARMING_GUILD_SOUTH

      public static final BankLocation FARMING_GUILD_SOUTH

    • FEROX_ENCLAVE_BANK

      public static final BankLocation FEROX_ENCLAVE_BANK

    • FOSSIL_ISLAND

      public static final BankLocation FOSSIL_ISLAND

    • FOSSIL_ISLAND_TENT

      public static final BankLocation FOSSIL_ISLAND_TENT

    • GRAND_EXCHANGE_BANK

      public static final BankLocation GRAND_EXCHANGE_BANK

    • GRAND_TREE_SOUTH_BANK

      public static final BankLocation GRAND_TREE_SOUTH_BANK

    • GRAND_TREE_WEST_BANK

      public static final BankLocation GRAND_TREE_WEST_BANK

    • HALLOWED_SEPULCHRE

      public static final BankLocation HALLOWED_SEPULCHRE

    • HOSIDIUS_BANK

      public static final BankLocation HOSIDIUS_BANK

    • HOSIDIUS_KITCHEN

      public static final BankLocation HOSIDIUS_KITCHEN

    • HOSIDIUS_VINE_YARD

      public static final BankLocation HOSIDIUS_VINE_YARD

    • HUNTER_GUILD

      public static final BankLocation HUNTER_GUILD

    • JATIZSO_BANK

      public static final BankLocation JATIZSO_BANK

    • KOUREND_CASTLE_BANK

      public static final BankLocation KOUREND_CASTLE_BANK

    • LLETYA_BANK

      public static final BankLocation LLETYA_BANK

    • LUMB_CELLAR

      public static final BankLocation LUMB_CELLAR

    • LUMBRIDGE_BANK

      public static final BankLocation LUMBRIDGE_BANK

    • MARIM

      public static final BankLocation MARIM

    • LUNAR_ISLE

      public static final BankLocation LUNAR_ISLE

    • MINING_GUILD

      public static final BankLocation MINING_GUILD

    • MISTROCK

      public static final BankLocation MISTROCK

    • MOR_UL_REK

      public static final BankLocation MOR_UL_REK

    • MOS_LEHARMLESS_EAST

      public static final BankLocation MOS_LEHARMLESS_EAST

    • MOS_LEHARMLESS_WEST

      public static final BankLocation MOS_LEHARMLESS_WEST

    • MOUNT_KARUULM

      public static final BankLocation MOUNT_KARUULM

    • MYTHS_GUILD

      public static final BankLocation MYTHS_GUILD

    • NARDAH

      public static final BankLocation NARDAH

    • NEITIZNOT_BANK

      public static final BankLocation NEITIZNOT_BANK

    • NEMUS_RETREAT

      public static final BankLocation NEMUS_RETREAT

    • NEX_BANK

      public static final BankLocation NEX_BANK

    • PANDEMONIUM

      public static final BankLocation PANDEMONIUM

    • PORT_KHAZARD_BANK

      public static final BankLocation PORT_KHAZARD_BANK

    • PORT_PHASMATYS_BANK

      public static final BankLocation PORT_PHASMATYS_BANK

    • PORT_PISCARILIUS_BANK

      public static final BankLocation PORT_PISCARILIUS_BANK

    • PRIFDDINAS_NORTH

      public static final BankLocation PRIFDDINAS_NORTH

    • PRIFDDINAS_SOUTH

      public static final BankLocation PRIFDDINAS_SOUTH

    • QUETZACALLI_GORGE

      public static final BankLocation QUETZACALLI_GORGE

    • ROGUES_DEN

      public static final BankLocation ROGUES_DEN

    • SEERS_VILLAGE_BANK

      public static final BankLocation SEERS_VILLAGE_BANK

    • SHANTAY_PASS_BANK

      public static final BankLocation SHANTAY_PASS_BANK

    • SHAYZIEN_ENCAMPMENT

      public static final BankLocation SHAYZIEN_ENCAMPMENT

    • SHAYZIEN_NORTH

      public static final BankLocation SHAYZIEN_NORTH

    • SHILO_VILLAGE_BANK

      public static final BankLocation SHILO_VILLAGE_BANK

    • SOUL_WARS

      public static final BankLocation SOUL_WARS

    • TAL_TEKLAN

      public static final BankLocation TAL_TEKLAN

    • TEMPLE_OF_THE_EYE

      public static final BankLocation TEMPLE_OF_THE_EYE

    • TEMPOROSS

      public static final BankLocation TEMPOROSS

    • TOMBS_OF_AMASCUT

      public static final BankLocation TOMBS_OF_AMASCUT

    • TREE_GNOME_STRONGHOLD_BANK

      public static final BankLocation TREE_GNOME_STRONGHOLD_BANK

    • TZHAAR

      public static final BankLocation TZHAAR

    • VARROCK_EAST_BANK

      public static final BankLocation VARROCK_EAST_BANK

    • VARROCK_WEST_BANK

      public static final BankLocation VARROCK_WEST_BANK

    • VER_SINHAZA_BANK

      public static final BankLocation VER_SINHAZA_BANK

    • WARRIORS_GUILD

      public static final BankLocation WARRIORS_GUILD

    • WINTERTODT_BANK

      public static final BankLocation WINTERTODT_BANK

    • WOODCUTTING_GUILD

      public static final BankLocation WOODCUTTING_GUILD

    • YANILLE_BANK

      public static final BankLocation YANILLE_BANK

    • FISHING_GUILD

      public static final BankLocation FISHING_GUILD

    • LANDS_END

      public static final BankLocation LANDS_END

  • Method Details

    • values

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

    • getNearest

      public static BankLocation getNearest()
      Finds the nearest bank by straight-line distance.

      Only considers banks whose requirements are fulfilled.

      Returns:
      the nearest accessible bank, or null if none found

    • getNearestPath

      public static BankLocation getNearestPath(boolean useTeleports)
      Finds the nearest bank by path distance, optionally using teleports.

      Calculates actual walking paths to each bank and returns the one with the shortest path. Teleports can be included in pathfinding.

      Parameters:
      useTeleports - whether to consider teleports in pathfinding
      Returns:
      the nearest accessible bank by path, or null if none found

    • getNearestPath

      public static BankLocation getNearestPath()
      Finds the nearest bank by path distance without using teleports.
      Returns:
      the nearest accessible bank by walking path

    • findNearest

      public static BankLocation findNearest()
      Finds the nearest bank using multi-area pathfinding with default options.

      Uses teleports, transports, home teleports, minigame teleports, and avoids wilderness.

      Returns:
      the nearest accessible bank, or null if no path found

    • findNearest

      public static BankLocation findNearest(List<BankLocation> locations, WalkOptions options)
      Finds the nearest bank and returns both the bank location and path.

      This method efficiently finds the nearest bank by pathfinding to all usable banks simultaneously using multi-area pathfinding.

      Parameters:
      options - walk options for pathfinding
      Returns:
      result containing bank, or null if not found

    • canUse

      public boolean canUse()
      Checks if this bank location can be used (all requirements met).
      Returns:
      true if the bank is accessible, false otherwise

    • toString

      public String toString()
      Returns a formatted display name for this bank location.
      Overrides:
      toString in class Enum<BankLocation>
      Returns:
      the formatted bank name