Package net.storm.api.entities

Interface ITiles

All Superinterfaces:
EntityProvider<ITile>
public interface ITiles extends EntityProvider<ITile>
Provides access to all tiles in the loaded scene.

This interface extends EntityProvider to provide tile-specific querying capabilities. The scene is a rectangular grid of tiles, typically 104x104 tiles per plane (height level), with up to 4 planes (0-3).

Tiles serve as the fundamental spatial units in the game world. Each tile can contain:

  • Game objects (trees, rocks, doors, etc.)
  • Wall objects (walls, fences, etc.)
  • Ground objects (floor decorations)
  • Decorative objects (wall decorations)
  • Ground items (dropped items)

The provider offers multiple ways to access tiles:

Example usage: 

 
 ITiles tiles = Static.getTiles();

 // Get tile at a world point
 WorldPoint myLocation = new WorldPoint(3222, 3218, 0);
 ITile tile = tiles.getAt(myLocation);

 // Access objects on the tile
 List<IGameObject> objects = tile.getIGameObjects();

 // Iterate over all tiles on current plane
 ITile[][] allTiles = tiles.getRaw();
 for (int x = 0; x < tiles.getSizeX(); x++) {
     for (int y = 0; y < tiles.getSizeY(); y++) {
         ITile t = allTiles[x][y];
         // Process tile...
     }
 }

See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    ITile
    getAt(int plane, net.runelite.api.Point sceneLocation)
    Gets the tile at a specific plane and scene location.
    ITile
    getAt(net.runelite.api.coords.WorldPoint worldPoint)
    Gets the tile at a specific world point.
    ITile[][]
    getRaw()
    Gets the raw 2D array of tiles for the current plane.
    ITile[][][]
    getRawFloors()
    Gets the raw 3D array of tiles for all planes.
    int
    getSizeX()
    Gets the width of the scene in tiles.
    int
    getSizeY()
    Gets the height of the scene in tiles.
    int
    getWorldViewId()
    Gets the world view ID for this tile grid.

    Methods inherited from interface net.storm.api.entities.EntityProvider

    getAll

  • Method Details

    • getAt

      ITile getAt(int plane, net.runelite.api.Point sceneLocation)
      Gets the tile at a specific plane and scene location.

      Scene coordinates are local to the currently loaded scene and range from 0 to the scene size minus one (typically 0-103).

      Parameters:
      plane - the plane (height level, typically 0-3)
      sceneLocation - the scene-local coordinates as a Point (0 to sizeX/sizeY - 1)
      Returns:
      the tile at the specified location, or null if coordinates are invalid

    • getRaw

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

      This method returns a direct reference to the internal tile array for the current height level (plane). The array dimensions are typically [104][104] for a full scene, indexed as [x][y].

      Note: The returned array should not be modified directly.

      Returns:
      the 2D tile array for the current plane, indexed as [x][y]

    • getRawFloors

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

      This method returns a direct reference to the internal tile array for all height levels. The array dimensions are typically [4][104][104] where:

      • First dimension is plane (0-3)
      • Second dimension is X coordinate (0 to sizeX - 1)
      • Third dimension is Y coordinate (0 to sizeY - 1)

      Note: The returned array should not be modified directly.

      Returns:
      the 3D tile array for all planes, indexed as [plane][x][y]

    • getAt

      ITile getAt(net.runelite.api.coords.WorldPoint worldPoint)
      Gets the tile at a specific world point.

      This is the most commonly used method for retrieving tiles. The world point is automatically converted to scene coordinates. If the world point is outside the currently loaded scene, null is returned.

      Parameters:
      worldPoint - the world coordinates (absolute game coordinates)
      Returns:
      the tile at the specified world point, or null if not in the loaded scene

    • getSizeX

      int getSizeX()
      Gets the width of the scene in tiles.

      For a standard scene, this is typically 104 tiles.

      Returns:
      the scene width in tiles

    • getSizeY

      int getSizeY()
      Gets the height of the scene in tiles.

      For a standard scene, this is typically 104 tiles.

      Returns:
      the scene height in tiles

    • getWorldViewId

      int getWorldViewId()
      Gets the world view ID for this tile grid.

      The world view ID identifies which world view this tile grid belongs to. This is primarily relevant in instanced areas where multiple world views may exist simultaneously, such as in certain minigames or instances.

      Returns:
      the world view ID for this tile grid