Package rs.kreme.ksbot.api.hooks

Class WorldArea

  • public class WorldArea
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      WorldArea​(int x, int y, int width, int height, int plane)  
      WorldArea​(net.runelite.api.coords.WorldPoint... points)  
      WorldArea​(net.runelite.api.coords.WorldPoint a, net.runelite.api.coords.WorldPoint b)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean contains​(int px, int py, int plane)  
      boolean contains​(net.runelite.api.Actor actor)
      Checks if the specified actor is contained within this WorldArea.
      boolean contains​(net.runelite.api.coords.WorldPoint other)  
      boolean contains​(WorldArea other)  
      boolean contains​(KSGroundItem groundItem)
      Checks if the specified ground item is contained within this WorldArea.
      boolean contains​(KSObject object)
      Checks if the specified tile object is contained within this WorldArea.
      boolean equals​(java.lang.Object obj)  
      net.runelite.api.coords.WorldPoint getCentrePoint()  
      int getHeight()  
      int getMaxX()  
      int getMaxY()  
      int getPlane()  
      net.runelite.api.coords.WorldPoint getRandomPoint()  
      int getWidth()  
      int getX()  
      int getY()  
      int hashCode()  
      boolean overlaps​(WorldArea other)  
      java.lang.String toString()  
      java.util.List<net.runelite.api.coords.WorldPoint> toWorldPointList()
      Accumulates all the WorldPoints that this WorldArea contains and returns them as a list

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • WorldArea

        public WorldArea​(int x,
                 int y,
                 int width,
                 int height,
                 int plane)

      • WorldArea

        public WorldArea​(net.runelite.api.coords.WorldPoint a,
                 net.runelite.api.coords.WorldPoint b)

      • WorldArea

        public WorldArea​(net.runelite.api.coords.WorldPoint... points)

    • Method Detail

      • getX

        public int getX()

      • getY

        public int getY()

      • getWidth

        public int getWidth()

      • getHeight

        public int getHeight()

      • getPlane

        public int getPlane()

      • getMaxX

        public int getMaxX()

      • getMaxY

        public int getMaxY()

      • contains

        public boolean contains​(int px,
                        int py,
                        int plane)

      • contains

        public boolean contains​(WorldArea other)

      • contains

        public boolean contains​(net.runelite.api.coords.WorldPoint other)

      • overlaps

        public boolean overlaps​(WorldArea other)

      • getCentrePoint

        public net.runelite.api.coords.WorldPoint getCentrePoint()

      • contains

        public boolean contains​(net.runelite.api.Actor actor)
        Checks if the specified actor is contained within this WorldArea.
        Parameters:
        actor - The actor to check.
        Returns:
        True if the actor's location is within the area, false otherwise.

      • getRandomPoint

        public net.runelite.api.coords.WorldPoint getRandomPoint()

      • contains

        public boolean contains​(KSObject object)
        Checks if the specified tile object is contained within this WorldArea.
        Parameters:
        object - The tile object to check.
        Returns:
        True if the tile object's location is within the area, false otherwise.

      • contains

        public boolean contains​(KSGroundItem groundItem)
        Checks if the specified ground item is contained within this WorldArea.
        Parameters:
        groundItem - The ground item to check.
        Returns:
        True if the ground item's location is within the area, false otherwise.

      • toWorldPointList

        public java.util.List<net.runelite.api.coords.WorldPoint> toWorldPointList()
        Accumulates all the WorldPoints that this WorldArea contains and returns them as a list
        Returns:
        Returns the WorldPoints in this WorldArea

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object