Package net.runelite.api
Interface Scene
-
- All Superinterfaces:
Node
,Renderable
public interface Scene extends Renderable
Represents a 3D scene
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
buildRoofs()
int
getBaseX()
Returns the x-axis base coordinate.int
getBaseY()
Returns the y-axis base coordinate.int
getDrawDistance()
Tile[][][]
getExtendedTiles()
Get the extended scene.byte[][][]
getExtendedTileSettings()
Get the extended tile settings.int[][][]
getInstanceTemplateChunks()
Contains a 3D array of template chunks for instanced areas.int[]
getMapRegions()
Gets an array of map region IDs that are currently loaded.int
getMinLevel()
Get the minimum scene level which will be renderedshort[][][]
getOverlayIds()
Get the overlay ids for the scene.int
getRoofRemovalMode()
int[][][]
getRoofs()
int[][][]
getTileHeights()
Get the heights of the tiles on the scene.Tile[][][]
getTiles()
Gets the tiles in the scenebyte[][][]
getTileShapes()
Get the shapes of the tiles for the scene.short[][][]
getUnderlayIds()
Get the underlay ids for the scene.int
getWorldViewId()
Get the world view id of this sceneboolean
isInstance()
Check if this scene is an instancevoid
removeGameObject(GameObject gameObject)
Remove a game object from the scenevoid
removeTile(Tile tile)
Remove a tile from the scenevoid
setDrawDistance(int drawDistance)
void
setMinLevel(int minLevel)
Set the minimum scene level which will be renderedvoid
setRoofRemovalMode(int flags)
-
Methods inherited from interface net.runelite.api.Node
getHash, getNext, getPrevious
-
Methods inherited from interface net.runelite.api.Renderable
getModel, getModelHeight, setModelHeight
-
-
-
-
Method Detail
-
getTiles
Tile[][][] getTiles()
Gets the tiles in the scene- Returns:
- a 4x104x104 array of tiles in [plane][x][y]
-
getExtendedTiles
Tile[][][] getExtendedTiles()
Get the extended scene. This is larger than 104x104, and its size isConstants.EXTENDED_SCENE_SIZE
.
-
getExtendedTileSettings
byte[][][] getExtendedTileSettings()
Get the extended tile settings. This is larger than 104x104, and its size isConstants.EXTENDED_SCENE_SIZE
.
-
getDrawDistance
int getDrawDistance()
-
setDrawDistance
void setDrawDistance(int drawDistance)
-
getWorldViewId
int getWorldViewId()
Get the world view id of this scene- Returns:
- the world view id, or -1 if this is the top level scene
-
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
-
-
buildRoofs
void buildRoofs()
-
getRoofs
int[][][] getRoofs()
-
setRoofRemovalMode
void setRoofRemovalMode(int flags)
-
getRoofRemovalMode
int getRoofRemovalMode()
-
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
-
isInstance
boolean isInstance()
Check if this scene is an instance- Returns:
- See Also:
getInstanceTemplateChunks()
-
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
-
getMapRegions
int[] getMapRegions()
Gets an array of map region IDs that are currently loaded.- Returns:
- the map regions
-
-