Package net.runelite.api

Interface Scene

  • public interface Scene
    Represents the entire 3D scene

    • Method Detail

      • getTiles

        Tile[][][] getTiles()
        Gets the tiles in the scene
        Returns:
        a 4x104x104 array of tiles in [plane][x][y]

      • getExtendedTileSettings

        byte[][][] getExtendedTileSettings()
        Get the extended tile settings. This is larger than 104x104, and its size is Constants.EXTENDED_SCENE_SIZE.

      • getDrawDistance

        int getDrawDistance()

      • setDrawDistance

        void setDrawDistance​(int drawDistance)

      • getMinLevel

        int getMinLevel()
        Get the minimum scene level which will be rendered
        Returns:
        the plane of the minimum level

      • setMinLevel

        void setMinLevel​(int minLevel)
        Set the minimum scene level which will be rendered
        Parameters:
        minLevel - the plane of the minimum level

      • removeTile

        void removeTile​(Tile tile)
        Remove a tile from the scene
        Parameters:
        tile -

      • removeGameObject

        void removeGameObject​(GameObject gameObject)
        Remove a game object from the scene
        Parameters:
        gameObject -

      • generateHouses

        void generateHouses()

      • setRoofRemovalMode

        void setRoofRemovalMode​(int flags)

      • getUnderlayIds

        short[][][] getUnderlayIds()
        Get the underlay ids for the scene. The value stored is id + 1, with 0 for no underlay.
        Returns:

      • getOverlayIds

        short[][][] getOverlayIds()
        Get the overlay ids for the scene. The value stored is id + 1, with 0 for no overlay.
        Returns:

      • getTileShapes

        byte[][][] getTileShapes()
        Get the shapes of the tiles for the scene.
        Returns:

      • getTileHeights

        int[][][] getTileHeights()
        Get the heights of the tiles on the scene.
        Returns:

      • getBaseX

        int getBaseX()
        Returns the x-axis base coordinate.

        This value is the x-axis world coordinate of tile (0, 0) in this scene (ie. the bottom-left most coordinates in the scene).

        Returns:
        the base x-axis coordinate

      • getBaseY

        int getBaseY()
        Returns the y-axis base coordinate.

        This value is the y-axis world coordinate of tile (0, 0) in this scene (ie. the bottom-left most coordinates in the scene).

        Returns:
        the base y-axis coordinate

      • getInstanceTemplateChunks

        int[][][] getInstanceTemplateChunks()
        Contains a 3D array of template chunks for instanced areas.

        The array returned is of format [z][x][y], where z is the plane, x and y the x-axis and y-axis coordinates of a tile divided by the size of a chunk.

        The bits of the int value held by the coordinates are -1 if there is no data, structured in the following format: 

        
  0                   1                   2                   3
  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 | |rot|     y chunk coord     |    x chunk coord    |pln|       |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
        Returns:
        the array of instance template chunks
        See Also:
        Constants.CHUNK_SIZE, InstanceTemplates