Class Tiles

java.lang.Object
net.storm.sdk.entities.Tiles

public class Tiles extends Object
Utility class for accessing and querying game tiles.

Tiles represent individual squares in the game world that can contain objects, items, and decorations. This class provides methods for:

  • Getting tiles at specific locations
  • Filtering tiles by custom predicates
  • Accessing raw tile data arrays
  • Getting surrounding tiles within a radius
  • Getting the currently hovered tile
See Also:
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    static List<ITile>
    Gets all tiles in the loaded scene.
    static List<ITile>
    getAll(Predicate<? super ITile> filter)
    Gets all tiles in the loaded scene that match the given predicate.
    static ITile
    getAt(int plane, net.runelite.api.Point sceneLocation)
    Gets the tile at a specific scene location on a given plane.
    static ITile
    getAt(net.runelite.api.coords.WorldPoint worldPoint)
    Gets the tile at a specific world point.
    static ITile
    Gets the tile currently under the mouse cursor.
    static ITile[][]
    Gets the raw 2D array of tiles for the current plane.
    static ITile[][][]
    Gets the raw 3D array of tiles for all planes.
    static List<ITile>
    getSurrounding(net.runelite.api.coords.WorldPoint worldPoint, int radius)
    Gets all tiles within a specified radius of a world point.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • Tiles

      public Tiles()
  • Method Details

    • getAt

      public static ITile getAt(int plane, net.runelite.api.Point sceneLocation)
      Gets the tile at a specific scene location on a given plane.
      Parameters:
      plane - the plane (height level, 0-3)
      sceneLocation - the scene coordinates as a Point
      Returns:
      the tile at the specified location, or null if not found
    • getAt

      public static ITile getAt(net.runelite.api.coords.WorldPoint worldPoint)
      Gets the tile at a specific world point.
      Parameters:
      worldPoint - the world coordinates
      Returns:
      the tile at the specified location, or null if not in the loaded scene
    • getAll

      public static List<ITile> getAll(Predicate<? super ITile> filter)
      Gets all tiles in the loaded scene that match the given predicate.
      Parameters:
      filter - the predicate to filter tiles
      Returns:
      a list of matching tiles
    • getAll

      public static List<ITile> getAll()
      Gets all tiles in the loaded scene.
      Returns:
      a list of all tiles
    • getRaw

      public static ITile[][] getRaw()
      Gets the raw 2D array of tiles for the current plane.

      The array is indexed by [sceneX][sceneY].

      Returns:
      the raw tile array for the current plane
    • getRawFloors

      public static ITile[][][] getRawFloors()
      Gets the raw 3D array of tiles for all planes.

      The array is indexed by [sceneX][sceneY][plane].

      Returns:
      the raw tile array for all planes
    • getHoveredTile

      public static ITile getHoveredTile()
      Gets the tile currently under the mouse cursor.
      Returns:
      the hovered tile, or null if no tile is being hovered
    • getSurrounding

      public static List<ITile> getSurrounding(net.runelite.api.coords.WorldPoint worldPoint, int radius)
      Gets all tiles within a specified radius of a world point.

      Returns a square area of tiles centered on the given point.

      Parameters:
      worldPoint - the center point
      radius - the radius in tiles (creates a (2*radius+1) x (2*radius+1) area)
      Returns:
      a list of tiles within the radius