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

Class MovementConstants

java.lang.Object
net.storm.api.movement.pathfinder.model.MovementConstants
public class MovementConstants extends Object
Constants and utility methods for the movement and pathfinding system.

MovementConstants contains static definitions for:

  • Wilderness boundaries and special areas
  • Jewelry and teleport item arrays
  • Special world areas (Ferox, Hunter Guild, etc.)
  • Utility methods for area detection

Wilderness Definitions

Item Arrays

Arrays of item IDs for teleport jewelry with varying charges:

Special Areas

See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int[]
    AMULET_OF_GLORY
    Amulet of Glory item IDs (6 to 1 charges plus infinite).
    static final int[]
    AMULET_OF_THE_EYE
    Amulet of the Eye item IDs (all color variants).
    static final int[]
    ARDOUGNE_CLOAK
    Ardougne Cloak item IDs (all tiers).
    static final int[]
    BURNING_AMULET
    Burning Amulet item IDs (5 to 1 charges).
    static final int[]
    CHARTERSHIP_BLACKLITSED
    Items blacklisted from Charter Ships (contraband).
    static final int[]
    COMBAT_BRACELET
    Combat Bracelet item IDs (6 to 1 charges).
    static final int[]
    CONSTRUCTION_CAPE
    Construction Cape item IDs.
    static final int[]
    CRAFTING_CAPE
    Crafting Cape item IDs.
    static final int[]
    DIGSITE_PENDANT
    Digsite Pendant item IDs (5 to 1 charges).
    static final int[]
    DRAKANS_MEDALLION
    Drakan's Medallion item ID.
    static final int[]
    ENCHANTED_LYRE
    Enchanted Lyre item IDs (infinite and 5 to 1 charges).
    static final net.runelite.api.coords.WorldArea
    ESCAPE_CAVES
    World area for the Wilderness escape caves.
    static final int[]
    EXPLORERS_RING
    Explorer's Ring item IDs (medium to elite).
    static final int[]
    FAIRY_ITEMS
    Items required to use Fairy Rings (Dramen/Lunar staff variants).
    static final int[]
    FARMING_CAPE
    Farming Cape item IDs.
    static final net.runelite.api.coords.WorldArea[]
    FEROX_AREAS
    Safe areas within Ferox Enclave (both floors).
    static final int[]
    FISHING_CAPE
    Fishing Cape item IDs.
    static final int[]
    GAMES_NECKLACE
    Games Necklace item IDs (8 to 1 charges).
    static final int[]
    GHOMMALS_HILT
    Ghommal's Hilt item IDs (hard to grandmaster).
    static final Cuboid
    GOD_WARS_WILDERNESS_CUBOID
    Cuboid defining the God Wars Dungeon Wilderness section.
    static final int[]
    HOUSE_ITEMS
    Items that can teleport to Player-Owned House.
    static net.runelite.api.coords.WorldPoint
    HOUSE_POINT
    Virtual world point representing the Player-Owned House location for pathfinding.
    static final net.runelite.api.coords.WorldArea[]
    HUNTER_GUILD
    Hunter Guild boundaries (all floors including basement).
    static int
    LAST_BIRD_TRANSPORT
    Varbit ID storing the last used bird transport destination index.
    static final int[]
    LIGHT_SOURCES
    Valid light sources for dark areas (caves, underground).
    static final Cuboid
    MAIN_WILDERNESS_CUBOID
    Cuboid defining the main above-ground Wilderness boundaries.
    static final int[]
    MAX_CAPE
    Max Cape item IDs.
    static final net.runelite.api.Skill[]
    MEMBER_SKILLS
    Array of member-only skills (used for membership checks).
    static final int[]
    NECKLACE_OF_PASSAGE
    Necklace of Passage item IDs (5 to 1 charges).
    static final Polygon
    NOT_WILDERNESS_BLACK_KNIGHTS
    Polygon defining the Black Knights' Fortress area (not Wilderness despite coordinates).
    static final int[]
    QUEST_POINT_CAPE
    Quest Point Cape item IDs.
    static final int[]
    QUETZAL_WHISTLE
    Quetzal Whistle item IDs (all tiers).
    static final int[]
    RADAS_BLESSING
    Rada's Blessing item IDs (hard and elite).
    static final net.runelite.api.coords.WorldArea[]
    RESTRICTED_MINIGAME_TELEPORT_AREAS
    Areas where minigame teleports are restricted.
    static final int[]
    RING_OF_DUELING
    Ring of Dueling item IDs (8 to 1 charges).
    static final int[]
    RING_OF_THE_ELEMENTS
    Ring of the Elements item IDs.
    static final int[]
    RING_OF_WEALTH
    Ring of Wealth item IDs (5 to 1 charges).
    static final net.runelite.api.coords.WorldArea[]
    SAFE_WILDERNESS_UNDERGROUND
    Safe areas in underground Wilderness.
    static final int[]
    SKILLS_NECKLACE
    Skills Necklace item IDs (6 to 1 charges).
    static final int[]
    SLASH_ITEMS
    Items that can slash webs in the Wilderness.
    static final List<org.apache.commons.lang3.tuple.Pair<net.runelite.api.coords.WorldPoint,net.runelite.api.coords.WorldPoint>>
    SLASH_WEB_POINTS
    Pairs of points defining slashable web locations and their exit points.
    static final int[]
    SLAYER_RING
    Slayer Ring item IDs (eternal and 8 to 1 charges).
    static final int[]
    SPIRIT_TREE_BLACKLISTED
    Items blacklisted from Spirit Trees.
    static final List<String>
    STRONGHOLD_ANSWERS
    Valid answers for Security Stronghold doors.
    static final int[]
    TELEPORT_CRYSTAL
    Teleport Crystal item IDs (eternal and 5 to 1 charges).
    static final int[]
    UNDERWATER_REGION_IDS
    Region IDs for underwater areas.
    static int
    UNLOCKED_BIRD_TRANSPORT
    Varbit ID for checking if bird transport is unlocked (value >= 2 means unlocked).
    static int
    VISISTED_VARLAMORE
    Varbit ID for checking if Varlamore has been visited (value >= 2 means visited).
    static final net.runelite.api.coords.WorldArea
    WILDERNESS_ABOVE_GROUND
    World area for above-ground Wilderness.
    static final net.runelite.api.coords.WorldArea[]
    WILDERNESS_BOSS_AREAS
    Wilderness boss instanced areas (Callisto, Venenatis, Vet'ion).
    static final net.runelite.api.coords.WorldArea
    WILDERNESS_UNDERGROUND
    World area for underground Wilderness.
    static final Cuboid
    WILDERNESS_UNDERGROUND_CUBOID
    Cuboid defining underground Wilderness areas (Revenant Caves, etc.).
    static final int[]
    XERICS_TALISMAN
    Xeric's Talisman item IDs.

  • Constructor Summary

    Constructors
    Constructor
    Description
    MovementConstants()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static boolean
    hasVisitedVarlamore(IVars vars)
    Checks if the player has visited Varlamore.
    static boolean
    inDeathDomain()
    Checks if the player is currently in the Death's Domain (death storage area).
    static boolean
    inHuntersGuild(net.runelite.api.coords.WorldPoint location)
    Checks if a given location is within the Hunter's Guild.
    static boolean
    isInBarrows()
    Checks if the player is currently in Barrows.
    static boolean
    isInStronghold()
    Checks if the player is in the Security Stronghold.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • NOT_WILDERNESS_BLACK_KNIGHTS

      public static final Polygon NOT_WILDERNESS_BLACK_KNIGHTS
      Polygon defining the Black Knights' Fortress area (not Wilderness despite coordinates).

    • MAIN_WILDERNESS_CUBOID

      public static final Cuboid MAIN_WILDERNESS_CUBOID
      Cuboid defining the main above-ground Wilderness boundaries.

    • GOD_WARS_WILDERNESS_CUBOID

      public static final Cuboid GOD_WARS_WILDERNESS_CUBOID
      Cuboid defining the God Wars Dungeon Wilderness section.

    • WILDERNESS_UNDERGROUND_CUBOID

      public static final Cuboid WILDERNESS_UNDERGROUND_CUBOID
      Cuboid defining underground Wilderness areas (Revenant Caves, etc.).

    • WILDERNESS_ABOVE_GROUND

      public static final net.runelite.api.coords.WorldArea WILDERNESS_ABOVE_GROUND
      World area for above-ground Wilderness.

    • WILDERNESS_UNDERGROUND

      public static final net.runelite.api.coords.WorldArea WILDERNESS_UNDERGROUND
      World area for underground Wilderness.

    • ESCAPE_CAVES

      public static final net.runelite.api.coords.WorldArea ESCAPE_CAVES
      World area for the Wilderness escape caves.

    • MEMBER_SKILLS

      public static final net.runelite.api.Skill[] MEMBER_SKILLS
      Array of member-only skills (used for membership checks).

    • FEROX_AREAS

      public static final net.runelite.api.coords.WorldArea[] FEROX_AREAS
      Safe areas within Ferox Enclave (both floors).

    • WILDERNESS_BOSS_AREAS

      public static final net.runelite.api.coords.WorldArea[] WILDERNESS_BOSS_AREAS
      Wilderness boss instanced areas (Callisto, Venenatis, Vet'ion).

    • SAFE_WILDERNESS_UNDERGROUND

      public static final net.runelite.api.coords.WorldArea[] SAFE_WILDERNESS_UNDERGROUND
      Safe areas in underground Wilderness.

    • HUNTER_GUILD

      public static final net.runelite.api.coords.WorldArea[] HUNTER_GUILD
      Hunter Guild boundaries (all floors including basement).

    • RESTRICTED_MINIGAME_TELEPORT_AREAS

      public static final net.runelite.api.coords.WorldArea[] RESTRICTED_MINIGAME_TELEPORT_AREAS
      Areas where minigame teleports are restricted.

    • UNDERWATER_REGION_IDS

      public static final int[] UNDERWATER_REGION_IDS
      Region IDs for underwater areas.

    • RING_OF_DUELING

      public static final int[] RING_OF_DUELING
      Ring of Dueling item IDs (8 to 1 charges). Teleports to Duel Arena, Castle Wars, Ferox.

    • GAMES_NECKLACE

      public static final int[] GAMES_NECKLACE
      Games Necklace item IDs (8 to 1 charges). Teleports to minigame locations.

    • COMBAT_BRACELET

      public static final int[] COMBAT_BRACELET
      Combat Bracelet item IDs (6 to 1 charges). Teleports to combat-related locations.

    • RING_OF_WEALTH

      public static final int[] RING_OF_WEALTH
      Ring of Wealth item IDs (5 to 1 charges). Teleports to GE, Miscellania, Falador.

    • AMULET_OF_GLORY

      public static final int[] AMULET_OF_GLORY
      Amulet of Glory item IDs (6 to 1 charges plus infinite). Teleports to Edgeville, Karamja, etc.

    • NECKLACE_OF_PASSAGE

      public static final int[] NECKLACE_OF_PASSAGE
      Necklace of Passage item IDs (5 to 1 charges). Teleports to Wizards' Tower, Outpost, Desert.

    • BURNING_AMULET

      public static final int[] BURNING_AMULET
      Burning Amulet item IDs (5 to 1 charges). Teleports to Wilderness locations.

    • XERICS_TALISMAN

      public static final int[] XERICS_TALISMAN
      Xeric's Talisman item IDs. Teleports to Great Kourend locations.

    • SLAYER_RING

      public static final int[] SLAYER_RING
      Slayer Ring item IDs (eternal and 8 to 1 charges). Teleports to Slayer locations.

    • DIGSITE_PENDANT

      public static final int[] DIGSITE_PENDANT
      Digsite Pendant item IDs (5 to 1 charges). Teleports to Digsite, Fossil Island.

    • DRAKANS_MEDALLION

      public static final int[] DRAKANS_MEDALLION
      Drakan's Medallion item ID. Teleports to Morytania locations.

    • SKILLS_NECKLACE

      public static final int[] SKILLS_NECKLACE
      Skills Necklace item IDs (6 to 1 charges). Teleports to skilling locations.

    • TELEPORT_CRYSTAL

      public static final int[] TELEPORT_CRYSTAL
      Teleport Crystal item IDs (eternal and 5 to 1 charges). Teleports to Prifddinas/Lletya.

    • ENCHANTED_LYRE

      public static final int[] ENCHANTED_LYRE
      Enchanted Lyre item IDs (infinite and 5 to 1 charges). Teleports to Rellekka.

    • SLASH_ITEMS

      public static final int[] SLASH_ITEMS
      Items that can slash webs in the Wilderness.

    • ARDOUGNE_CLOAK

      public static final int[] ARDOUGNE_CLOAK
      Ardougne Cloak item IDs (all tiers). Teleports to Ardougne Monastery.

    • QUEST_POINT_CAPE

      public static final int[] QUEST_POINT_CAPE
      Quest Point Cape item IDs. Teleports to Legends' Guild.

    • EXPLORERS_RING

      public static final int[] EXPLORERS_RING
      Explorer's Ring item IDs (medium to elite). Teleports to cabbage patch.

    • CONSTRUCTION_CAPE

      public static final int[] CONSTRUCTION_CAPE
      Construction Cape item IDs. Teleports to POH.

    • MAX_CAPE

      public static final int[] MAX_CAPE
      Max Cape item IDs. Can teleport to multiple locations via perks.

    • GHOMMALS_HILT

      public static final int[] GHOMMALS_HILT
      Ghommal's Hilt item IDs (hard to grandmaster). Teleports to Warrior's Guild.

    • RING_OF_THE_ELEMENTS

      public static final int[] RING_OF_THE_ELEMENTS
      Ring of the Elements item IDs. Teleports to elemental altars.

    • CRAFTING_CAPE

      public static final int[] CRAFTING_CAPE
      Crafting Cape item IDs. Teleports to Crafting Guild.

    • FARMING_CAPE

      public static final int[] FARMING_CAPE
      Farming Cape item IDs. Teleports to Farming Guild.

    • FISHING_CAPE

      public static final int[] FISHING_CAPE
      Fishing Cape item IDs. Teleports to Fishing Guild.

    • RADAS_BLESSING

      public static final int[] RADAS_BLESSING
      Rada's Blessing item IDs (hard and elite). Teleports to Kourend Woodland.

    • AMULET_OF_THE_EYE

      public static final int[] AMULET_OF_THE_EYE
      Amulet of the Eye item IDs (all color variants). Teleports to GOTR.

    • FAIRY_ITEMS

      public static final int[] FAIRY_ITEMS
      Items required to use Fairy Rings (Dramen/Lunar staff variants).

    • HOUSE_ITEMS

      public static final int[] HOUSE_ITEMS
      Items that can teleport to Player-Owned House.

    • CHARTERSHIP_BLACKLITSED

      public static final int[] CHARTERSHIP_BLACKLITSED
      Items blacklisted from Charter Ships (contraband).

    • SPIRIT_TREE_BLACKLISTED

      public static final int[] SPIRIT_TREE_BLACKLISTED
      Items blacklisted from Spirit Trees.

    • LIGHT_SOURCES

      public static final int[] LIGHT_SOURCES
      Valid light sources for dark areas (caves, underground).

    • QUETZAL_WHISTLE

      public static final int[] QUETZAL_WHISTLE
      Quetzal Whistle item IDs (all tiers). Used for Varlamore bird flight transport.

    • STRONGHOLD_ANSWERS

      public static final List<String> STRONGHOLD_ANSWERS
      Valid answers for Security Stronghold doors.

    • SLASH_WEB_POINTS

      public static final List<org.apache.commons.lang3.tuple.Pair<net.runelite.api.coords.WorldPoint,net.runelite.api.coords.WorldPoint>> SLASH_WEB_POINTS
      Pairs of points defining slashable web locations and their exit points.

    • HOUSE_POINT

      public static net.runelite.api.coords.WorldPoint HOUSE_POINT
      Virtual world point representing the Player-Owned House location for pathfinding.

    • VISISTED_VARLAMORE

      public static int VISISTED_VARLAMORE
      Varbit ID for checking if Varlamore has been visited (value >= 2 means visited).

    • UNLOCKED_BIRD_TRANSPORT

      public static int UNLOCKED_BIRD_TRANSPORT
      Varbit ID for checking if bird transport is unlocked (value >= 2 means unlocked).

    • LAST_BIRD_TRANSPORT

      public static int LAST_BIRD_TRANSPORT
      Varbit ID storing the last used bird transport destination index.

  • Constructor Details

    • MovementConstants

      public MovementConstants()

  • Method Details

    • inDeathDomain

      public static boolean inDeathDomain()
      Checks if the player is currently in the Death's Domain (death storage area).
      Returns:
      true if in Death's Domain region

    • isInStronghold

      public static boolean isInStronghold()
      Checks if the player is in the Security Stronghold.
      Returns:
      true if in any Stronghold region

    • inHuntersGuild

      public static boolean inHuntersGuild(net.runelite.api.coords.WorldPoint location)
      Checks if a given location is within the Hunter's Guild.
      Parameters:
      location - the world point to check
      Returns:
      true if the location is inside the Hunter's Guild boundaries

    • isInBarrows

      public static boolean isInBarrows()
      Checks if the player is currently in Barrows.
      Returns:
      true if in the Barrows region

    • hasVisitedVarlamore

      public static boolean hasVisitedVarlamore(IVars vars)
      Checks if the player has visited Varlamore.
      Parameters:
      vars - the vars accessor to read from
      Returns:
      true if VISITED_VARLAMORE varbit is >= 2