Package net.storm.sdk.movement

Class Movement

  • public class Movement
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      Movement()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static int calculateDistance​(java.util.List<net.runelite.api.coords.WorldPoint> start, net.runelite.api.coords.WorldArea destination)  
      static int calculateDistance​(java.util.List<net.runelite.api.coords.WorldPoint> start, net.runelite.api.coords.WorldPoint destination)  
      static int calculateDistance​(net.runelite.api.coords.WorldArea destination)  
      static int calculateDistance​(net.runelite.api.coords.WorldPoint destination)  
      static int calculateDistance​(net.runelite.api.coords.WorldPoint start, net.runelite.api.coords.WorldArea destination)  
      static int calculateDistance​(net.runelite.api.coords.WorldPoint start, net.runelite.api.coords.WorldPoint destination)  
      static net.runelite.api.coords.WorldPoint getDestination()  
      static net.runelite.api.coords.WorldPoint getNearestWalkableTile​(net.runelite.api.coords.WorldPoint source)  
      static net.runelite.api.coords.WorldPoint getNearestWalkableTile​(net.runelite.api.coords.WorldPoint source, java.util.function.Predicate<net.runelite.api.coords.WorldPoint> filter)  
      static net.runelite.api.coords.WorldPoint getNearestWalkableTile​(net.runelite.api.coords.WorldPoint source, CollisionMap collisionMap)  
      static net.runelite.api.coords.WorldPoint getNearestWalkableTile​(net.runelite.api.coords.WorldPoint source, CollisionMap collisionMap, java.util.function.Predicate<net.runelite.api.coords.WorldPoint> filter)  
      static TilePath getPath​(java.util.Collection<net.runelite.api.coords.WorldPoint> startPoints, net.runelite.api.coords.WorldArea destination)  
      static TilePath getPath​(java.util.Collection<net.runelite.api.coords.WorldPoint> startPoints, net.runelite.api.coords.WorldArea destination, boolean useCache)  
      static TilePath getPath​(java.util.Collection<net.runelite.api.coords.WorldPoint> startPoints, net.runelite.api.coords.WorldArea destination, CollisionMap collisionMap)  
      static TilePath getPath​(java.util.Collection<net.runelite.api.coords.WorldPoint> startPoints, net.runelite.api.coords.WorldArea destination, CollisionMap collisionMap, boolean useCache)  
      static TilePath getPath​(java.util.Collection<net.runelite.api.coords.WorldPoint> startPoints, net.runelite.api.coords.WorldArea destination, CollisionMap collisionMap, boolean useCache, boolean useTransports)  
      static TilePath getPath​(java.util.Collection<net.runelite.api.coords.WorldPoint> startPoints, net.runelite.api.coords.WorldArea destination, CollisionMap collisionMap, boolean useCache, boolean useTransports, java.util.HashMap<net.runelite.api.coords.WorldPoint,​Teleport> teleports)  
      static TilePath getPath​(java.util.Collection<net.runelite.api.coords.WorldPoint> start, net.runelite.api.coords.WorldArea destination, WalkOptions options, java.util.HashMap<net.runelite.api.coords.WorldPoint,​Teleport> teleports)  
      static TilePath getPath​(java.util.Collection<net.runelite.api.coords.WorldPoint> start, net.runelite.api.coords.WorldArea destination, WalkOptions options, java.util.HashMap<net.runelite.api.coords.WorldPoint,​Teleport> teleports, long maxTimeMS, int maxPaths, boolean offThread)  
      static TilePath getPath​(java.util.Collection<net.runelite.api.coords.WorldPoint> startPoints, net.runelite.api.coords.WorldPoint destination)  
      static TilePath getPath​(java.util.Collection<net.runelite.api.coords.WorldPoint> startPoints, net.runelite.api.coords.WorldPoint destination, CollisionMap collisionMap)  
      static TilePath getPath​(net.runelite.api.coords.WorldArea destination)  
      static TilePath getPath​(net.runelite.api.coords.WorldArea destination, CollisionMap collisionMap)  
      static TilePath getPath​(net.runelite.api.coords.WorldPoint destination)  
      static TilePath getPath​(net.runelite.api.coords.WorldPoint destination, CollisionMap collisionMap)  
      static int getRunEnergy()  
      static boolean isRunEnabled()  
      static boolean isStaminaBoosted()  
      static boolean isWalking()  
      static void setDestination​(int sceneX, int sceneY)
      Force walk to a scene X Y point.
      static void toggleRun()
      Toggles run using the minimap orb.
      static void walk​(net.runelite.api.coords.WorldPoint worldPoint)
      Force walk to a WorldPoint.
      static void walk​(Locatable locatable)
      Force walk towards a Locatable
      static boolean walkTo​(int x, int y)
      Pathfind towards a given World X and Y, using a the GlobalCollisionMap.
      static boolean walkTo​(int x, int y, int plane)
      Pathfind towards a given World X, Y and Z, using a the GlobalCollisionMap.
      static boolean walkTo​(net.runelite.api.coords.WorldArea worldArea)
      Pathfind towards a given area, using a the GlobalCollisionMap.
      static boolean walkTo​(net.runelite.api.coords.WorldArea worldArea, java.lang.Boolean useTeleports)  
      static boolean walkTo​(net.runelite.api.coords.WorldArea worldArea, CollisionMap collisionMap)
      Pathfind towards a given area, using a custom CollisionMap.
      static boolean walkTo​(net.runelite.api.coords.WorldArea worldArea, CollisionMap collisionMap, java.lang.Boolean useTeleports)  
      static boolean walkTo​(net.runelite.api.coords.WorldArea destination, WalkOptions options)  
      static boolean walkTo​(net.runelite.api.coords.WorldArea destination, WalkOptions options, long maxTimeMS, int maxPaths)
      Pathfind towards a destination using custom options.
      static boolean walkTo​(net.runelite.api.coords.WorldPoint worldPoint)
      Pathfind towards a given worldPoint, using a the GlobalCollisionMap.
      static boolean walkTo​(net.runelite.api.coords.WorldPoint worldPoint, boolean useTeleports)  
      static boolean walkTo​(net.runelite.api.coords.WorldPoint worldPoint, CollisionMap collisionMap)
      Pathfind towards a given point, using a custom CollisionMap.
      static boolean walkTo​(net.runelite.api.coords.WorldPoint worldPoint, CollisionMap collisionMap, boolean useTeleports)  
      static boolean walkTo​(net.runelite.api.coords.WorldPoint destination, WalkOptions options)  
      static boolean walkTo​(net.runelite.api.coords.WorldPoint destination, WalkOptions options, long maxTimeMS, int maxPaths)  
      static boolean walkTo​(Locatable locatable)
      Pathfind towards a given Locatable entity, using a the GlobalCollisionMap.
      static boolean walkTo​(BankLocation bankLocation)
      Pathfind towards a given BankLocation, using a the GlobalCollisionMap.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Movement

        public Movement()

    • Method Detail

      • setDestination

        public static void setDestination​(int sceneX,
                                  int sceneY)
        Force walk to a scene X Y point.
        Parameters:
        sceneX -
        sceneY -

      • getDestination

        @Nullable
public static net.runelite.api.coords.WorldPoint getDestination()
        Returns:
        The current destination if set.

      • isWalking

        public static boolean isWalking()
        Returns:
        Whether the local player is currently pathing.

      • walk

        public static void walk​(net.runelite.api.coords.WorldPoint worldPoint)
        Force walk to a WorldPoint.
        Parameters:
        worldPoint - The destination.

      • walkTo

        public static boolean walkTo​(net.runelite.api.coords.WorldPoint worldPoint,
                             CollisionMap collisionMap)
        Pathfind towards a given point, using a custom CollisionMap.
        Parameters:
        worldPoint - The destination.
        collisionMap - The collision map.
        Returns:
        True if the calculated path is the full path to the destination, false if it is a partial path.

      • walkTo

        public static boolean walkTo​(net.runelite.api.coords.WorldPoint worldPoint,
                             CollisionMap collisionMap,
                             boolean useTeleports)

      • walkTo

        public static boolean walkTo​(net.runelite.api.coords.WorldPoint worldPoint,
                             boolean useTeleports)

      • walkTo

        public static boolean walkTo​(net.runelite.api.coords.WorldArea worldArea,
                             CollisionMap collisionMap)
        Pathfind towards a given area, using a custom CollisionMap.
        Parameters:
        worldArea - The destination area.
        collisionMap - The collision map.
        Returns:
        True if the calculated path is the full path to the destination, false if it is a partial path.

      • walkTo

        public static boolean walkTo​(net.runelite.api.coords.WorldArea worldArea,
                             java.lang.Boolean useTeleports)

      • walkTo

        public static boolean walkTo​(net.runelite.api.coords.WorldArea worldArea,
                             CollisionMap collisionMap,
                             java.lang.Boolean useTeleports)

      • walkTo

        public static boolean walkTo​(net.runelite.api.coords.WorldArea worldArea)
        Pathfind towards a given area, using a the GlobalCollisionMap.
        Parameters:
        worldArea - The destination area.
        Returns:
        True if the calculated path is the full path to the destination, false if it is a partial path.

      • walk

        public static void walk​(Locatable locatable)
        Force walk towards a Locatable
        Parameters:
        locatable - The destination entity.

      • walkTo

        public static boolean walkTo​(net.runelite.api.coords.WorldPoint worldPoint)
        Pathfind towards a given worldPoint, using a the GlobalCollisionMap.
        Parameters:
        worldPoint - The destination.
        Returns:
        True if the calculated path is the full path to the destination, false if it is a partial path.

      • walkTo

        public static boolean walkTo​(Locatable locatable)
        Pathfind towards a given Locatable entity, using a the GlobalCollisionMap.
        Parameters:
        locatable - The destination entity.
        Returns:
        True if the calculated path is the full path to the destination, false if it is a partial path.

      • walkTo

        public static boolean walkTo​(BankLocation bankLocation)
        Pathfind towards a given BankLocation, using a the GlobalCollisionMap.
        Parameters:
        bankLocation - The destination bank.
        Returns:
        True if the calculated path is the full path to the destination, false if it is a partial path.

      • walkTo

        public static boolean walkTo​(int x,
                             int y)
        Pathfind towards a given World X and Y, using a the GlobalCollisionMap.
        Parameters:
        x - The destination worldX.
        y - The destination worldY.
        Returns:
        True if the calculated path is the full path to the destination, false if it is a partial path.

      • walkTo

        public static boolean walkTo​(int x,
                             int y,
                             int plane)
        Pathfind towards a given World X, Y and Z, using a the GlobalCollisionMap.
        Parameters:
        x - The destination worldX.
        y - The destination worldY.
        plane - The destination plane.
        Returns:
        True if the calculated path is the full path to the destination, false if it is a partial path.

      • walkTo

        public static boolean walkTo​(net.runelite.api.coords.WorldArea destination,
                             WalkOptions options,
                             long maxTimeMS,
                             int maxPaths)
        Pathfind towards a destination using custom options.

      • walkTo

        public static boolean walkTo​(net.runelite.api.coords.WorldPoint destination,
                             WalkOptions options,
                             long maxTimeMS,
                             int maxPaths)

      • walkTo

        public static boolean walkTo​(net.runelite.api.coords.WorldArea destination,
                             WalkOptions options)

      • walkTo

        public static boolean walkTo​(net.runelite.api.coords.WorldPoint destination,
                             WalkOptions options)

      • isRunEnabled

        public static boolean isRunEnabled()
        Returns:
        Whether run mode is currently enabled.

      • toggleRun

        public static void toggleRun()
        Toggles run using the minimap orb.

      • isStaminaBoosted

        public static boolean isStaminaBoosted()
        Returns:
        Whether the stamina boost effect is enabled.

      • getRunEnergy

        public static int getRunEnergy()
        Returns:
        The local player's remaining run energy.

      • calculateDistance

        public static int calculateDistance​(net.runelite.api.coords.WorldArea destination)
        Parameters:
        destination - The destination area.
        Returns:
        The tile distance towards a destination, starting from the local player.

      • calculateDistance

        public static int calculateDistance​(net.runelite.api.coords.WorldPoint start,
                                    net.runelite.api.coords.WorldArea destination)
        Parameters:
        start - The starting point.
        destination - The destination area.
        Returns:
        The tile distance towards a destination, starting from a given point.

      • calculateDistance

        public static int calculateDistance​(java.util.List<net.runelite.api.coords.WorldPoint> start,
                                    net.runelite.api.coords.WorldArea destination)
        Parameters:
        start - The starting points.
        destination - The destination area.
        Returns:
        The shortest tile distance towards a destination, starting from multiple points.

      • calculateDistance

        public static int calculateDistance​(net.runelite.api.coords.WorldPoint destination)
        Parameters:
        destination - The destination point.
        Returns:
        The tile distance towards a destination, starting from the local player.

      • calculateDistance

        public static int calculateDistance​(net.runelite.api.coords.WorldPoint start,
                                    net.runelite.api.coords.WorldPoint destination)
        Parameters:
        start - The starting point.
        destination - The destination point.
        Returns:
        The tile distance between two given points.

      • calculateDistance

        public static int calculateDistance​(java.util.List<net.runelite.api.coords.WorldPoint> start,
                                    net.runelite.api.coords.WorldPoint destination)
        Parameters:
        start - The starting points.
        destination - The destination point.
        Returns:
        The shortest tile distance towards a destination, starting from multiple points.

      • getPath

        public static TilePath getPath​(net.runelite.api.coords.WorldPoint destination)

      • getPath

        public static TilePath getPath​(net.runelite.api.coords.WorldPoint destination,
                               CollisionMap collisionMap)

      • getPath

        public static TilePath getPath​(java.util.Collection<net.runelite.api.coords.WorldPoint> startPoints,
                               net.runelite.api.coords.WorldPoint destination)

      • getPath

        public static TilePath getPath​(java.util.Collection<net.runelite.api.coords.WorldPoint> startPoints,
                               net.runelite.api.coords.WorldPoint destination,
                               CollisionMap collisionMap)

      • getPath

        public static TilePath getPath​(net.runelite.api.coords.WorldArea destination)

      • getPath

        public static TilePath getPath​(net.runelite.api.coords.WorldArea destination,
                               CollisionMap collisionMap)

      • getPath

        public static TilePath getPath​(java.util.Collection<net.runelite.api.coords.WorldPoint> startPoints,
                               net.runelite.api.coords.WorldArea destination)

      • getPath

        public static TilePath getPath​(java.util.Collection<net.runelite.api.coords.WorldPoint> startPoints,
                               net.runelite.api.coords.WorldArea destination,
                               CollisionMap collisionMap)

      • getPath

        public static TilePath getPath​(java.util.Collection<net.runelite.api.coords.WorldPoint> startPoints,
                               net.runelite.api.coords.WorldArea destination,
                               boolean useCache)

      • getPath

        public static TilePath getPath​(java.util.Collection<net.runelite.api.coords.WorldPoint> startPoints,
                               net.runelite.api.coords.WorldArea destination,
                               CollisionMap collisionMap,
                               boolean useCache)

      • getPath

        public static TilePath getPath​(java.util.Collection<net.runelite.api.coords.WorldPoint> startPoints,
                               net.runelite.api.coords.WorldArea destination,
                               CollisionMap collisionMap,
                               boolean useCache,
                               boolean useTransports)

      • getPath

        public static TilePath getPath​(java.util.Collection<net.runelite.api.coords.WorldPoint> startPoints,
                               net.runelite.api.coords.WorldArea destination,
                               CollisionMap collisionMap,
                               boolean useCache,
                               boolean useTransports,
                               java.util.HashMap<net.runelite.api.coords.WorldPoint,​Teleport> teleports)

      • getNearestWalkableTile

        public static net.runelite.api.coords.WorldPoint getNearestWalkableTile​(net.runelite.api.coords.WorldPoint source,
                                                                        java.util.function.Predicate<net.runelite.api.coords.WorldPoint> filter)

      • getNearestWalkableTile

        public static net.runelite.api.coords.WorldPoint getNearestWalkableTile​(net.runelite.api.coords.WorldPoint source,
                                                                        CollisionMap collisionMap,
                                                                        java.util.function.Predicate<net.runelite.api.coords.WorldPoint> filter)

      • getNearestWalkableTile

        public static net.runelite.api.coords.WorldPoint getNearestWalkableTile​(net.runelite.api.coords.WorldPoint source)

      • getNearestWalkableTile

        public static net.runelite.api.coords.WorldPoint getNearestWalkableTile​(net.runelite.api.coords.WorldPoint source,
                                                                        CollisionMap collisionMap)

      • getPath

        public static TilePath getPath​(java.util.Collection<net.runelite.api.coords.WorldPoint> start,
                               net.runelite.api.coords.WorldArea destination,
                               WalkOptions options,
                               java.util.HashMap<net.runelite.api.coords.WorldPoint,​Teleport> teleports,
                               long maxTimeMS,
                               int maxPaths,
                               boolean offThread)

      • getPath

        public static TilePath getPath​(java.util.Collection<net.runelite.api.coords.WorldPoint> start,
                               net.runelite.api.coords.WorldArea destination,
                               WalkOptions options,
                               java.util.HashMap<net.runelite.api.coords.WorldPoint,​Teleport> teleports)