SceneAPI
Scene API.
ClassRLPlugins API
public class SceneAPIMembers
Static methods
- List<Tile>checkPointsTo(Tile, Tile)
Returns path checkpoints from one tile to another.
- List<WorldPoint>checkPointsTo(WorldPoint, WorldPoint)
Returns path checkpoints from one world point to another.
- List<WorldPoint>filterReachable(List<WorldPoint>)
Filter reachable.
- List<WorldPoint>filterReachable(WorldPoint...)
Filter reachable.
- List<Tile>getAll()
Returns a list of all tiles in the current scene.
- List<Tile>getAll(Predicate<Tile>)
Returns a list of all tiles in the current scene that match the given filter.
- TilegetAt(LocalPoint)
Returns the tile at the specified local point.
- TilegetAt(WorldPoint)
Returns the tile at the specified world point.
- TilegetAt(int, int, int)
Returns the tile at the specified world coordinates and plane.
- List<Entity>getHoveredEntities()
Resolves scene menu targets in their existing menu order.
- TilegetHoveredTile()
Returns the tile currently hovered by the mouse cursor.
- WorldAreagetNextTravellingArea(WorldArea, WorldArea, boolean, Collection<WorldPoint>)
One source-derived NPC-style travelling step in the local player's collision view.
- WorldAreagetNextTravellingArea(WorldArea, WorldArea, boolean, Collection<WorldPoint>, int)
Explicit-view form for NPCs and successive predicted areas; never falls back to another view.
- List<Tile>getSurrounding(WorldPoint, int)
Returns a list of tiles surrounding the specified world point within the given radius.
- TilegetTile(WorldPoint)
The tile.
- booleanhasLineOfSightTo(Tile, Tile)
Whether it has line of sight to.
- booleanhasLineOfSightTo(WorldArea, WorldArea)
Pinned area line-of-sight semantics in the local player's current world view.
- booleanhasLineOfSightTo(WorldPoint, WorldPoint)
Whether it has line of sight to.
- booleanhasLineOfSightTo(WorldArea, WorldArea, int)
Explicit-view area line of sight for NPC prediction, without a top-level fallback.
- booleanisInteractionReachable(Locatable)
Checks cardinal walking access to an entity's interaction point.
- booleanisReachable(WorldPoint)
Determines if the destination world point is reachable from the player's current position.
- booleanisReachable(Tile, Tile)
Determines if the destination tile is reachable from the starting tile.
- booleanisReachable(WorldPoint, WorldPoint)
Determines if the destination world point is reachable from the starting world point.
- booleanisTileMovementBlocked(WorldPoint, int)
Tests full-tile movement occupancy, independently of directional walls or path reachability.
- booleanisTileObstacle(WorldPoint, int)
Full obstacle/occupancy check with the source-derived 19005696 mask, in one explicit view.
- WorldPointlosTileNextTo(WorldPoint)
Los tile next to.
- List<Tile>pathTo(Tile, Tile)
Finds a path from one tile to another and returns a list of tiles along the path.
- List<WorldPoint>pathTo(WorldPoint, WorldPoint)
Finds a path from one world point to another and returns a list of waypoints (WorldPoints) along the path.
- List<WorldPoint>reachableTiles()
Returns a list of all reachable tiles from the player's current position using a breadth-first search algorithm.
- List<WorldPoint>reachableTiles(WorldPoint)
Returns a list of all reachable tiles from the origins position using a breadth-first search algorithm.
checkPointsTo(Tile, Tile)static
public static List<Tile> checkPointsTo(Tile from, Tile to)Returns path checkpoints from one tile to another.
Parameters
from- From.
to- To.
checkPointsTo(WorldPoint, WorldPoint)static
public static List<WorldPoint> checkPointsTo(WorldPoint from, WorldPoint to)Returns path checkpoints from one world point to another.
Parameters
from- From.
to- To.
filterReachable(List<WorldPoint>)static
public static List<WorldPoint> filterReachable(List<WorldPoint> to)Filter reachable.
Parameters
to- To.
filterReachable(WorldPoint...)static
public static List<WorldPoint> filterReachable(WorldPoint... to)Filter reachable.
Parameters
to- To.
getAll()static
public static List<Tile> getAll()Returns a list of all tiles in the current scene.
Returns
A list of all tiles.
getAll(Predicate<Tile>)static
public static List<Tile> getAll(Predicate<Tile> filter)Returns a list of all tiles in the current scene that match the given filter.
Parameters
filter- A predicate to filter the tiles.
Returns
A list of tiles that match the filter.
getAt(LocalPoint)static
public static Tile getAt(LocalPoint localPoint)Returns the tile at the specified local point.
Parameters
localPoint- The local point to get the tile at.
Returns
The tile at the specified local point, or null if the point is out of bounds.
getAt(WorldPoint)static
public static Tile getAt(WorldPoint worldPoint)Returns the tile at the specified world point.
Parameters
worldPoint- The world point to get the tile at.
Returns
The tile at the specified world point, or null if the point is out of bounds.
getAt(int, int, int)static
public static Tile getAt(int worldX, int worldY, int plane)Returns the tile at the specified world coordinates and plane.
Parameters
worldX- The world X coordinate.
worldY- The world Y coordinate.
plane- The plane (z-level).
Returns
The tile at the specified coordinates and plane, or null if the coordinates are out of bounds.
getHoveredEntities()static
public static List<Entity> getHoveredEntities()Resolves scene menu targets in their existing menu order.
Repeated entries retain their order; unavailable targets are skipped. Each wrapper retains the entry's owning world view, including ground items in nested scenes.
getHoveredTile()static
public static Tile getHoveredTile()Returns the tile currently hovered by the mouse cursor.
Returns
The hovered tile, or null if no tile is hovered.
getNextTravellingArea(WorldArea, WorldArea, boolean, Collection<WorldPoint>)static
public static WorldArea getNextTravellingArea(WorldArea from, WorldArea target, boolean stopAtMeleeDistance, Collection<WorldPoint> obstacles)One source-derived NPC-style travelling step in the local player's collision view.
Parameters
from- From.
target- Target.
stopAtMeleeDistance- Stop at melee distance.
obstacles- Obstacles.
getNextTravellingArea(WorldArea, WorldArea, boolean, Collection<WorldPoint>, int)static
public static WorldArea getNextTravellingArea(WorldArea from, WorldArea target, boolean stopAtMeleeDistance, Collection<WorldPoint> obstacles, int worldViewId)Explicit-view form for NPCs and successive predicted areas; never falls back to another view.
Parameters
from- From.
target- Target.
stopAtMeleeDistance- Stop at melee distance.
obstacles- Obstacles.
worldViewId- World view id.
getSurrounding(WorldPoint, int)static
public static List<Tile> getSurrounding(WorldPoint worldPoint, int radius)Returns a list of tiles surrounding the specified world point within the given radius.
Parameters
worldPoint- The center world point.
radius- The radius around the center point to include tiles.
Returns
A list of tiles surrounding the specified world point.
getTile(WorldPoint)static
public static Tile getTile(WorldPoint worldPoint)The tile.
Parameters
worldPoint- World point.
hasLineOfSightTo(Tile, Tile)static
public static boolean hasLineOfSightTo(Tile source, Tile other)Whether it has line of sight to.
Parameters
source- Source.
other- Other.
hasLineOfSightTo(WorldArea, WorldArea)static
public static boolean hasLineOfSightTo(WorldArea from, WorldArea to)Pinned area line-of-sight semantics in the local player's current world view.
Parameters
from- From.
to- To.
hasLineOfSightTo(WorldPoint, WorldPoint)static
public static boolean hasLineOfSightTo(WorldPoint source, WorldPoint other)Whether it has line of sight to.
Parameters
source- Source.
other- Other.
hasLineOfSightTo(WorldArea, WorldArea, int)static
public static boolean hasLineOfSightTo(WorldArea from, WorldArea to, int worldViewId)Explicit-view area line of sight for NPC prediction, without a top-level fallback.
Parameters
from- From.
to- To.
worldViewId- World view id.
isInteractionReachable(Locatable)static
public static boolean isInteractionReachable(Locatable target)Checks cardinal walking access to an entity's interaction point.
The final step may enter an occupied tile, but may not cross a wall. This differs from walking onto a tile or reaching any tile around a large entity's footprint.
Parameters
target- Entity whose interaction point is checked.
Returns
True when the local player can reach the interaction point.
isReachable(WorldPoint)static
public static boolean isReachable(WorldPoint to)Determines if the destination world point is reachable from the player's current position.
Parameters
to- The destination WorldPoint.
Returns
True if the destination WorldPoint is reachable, false otherwise.
isReachable(Tile, Tile)static
public static boolean isReachable(Tile from, Tile to)Determines if the destination tile is reachable from the starting tile.
Parameters
from- The starting tile.
to- The destination tile.
Returns
True if the destination tile is reachable, false otherwise.
isReachable(WorldPoint, WorldPoint)static
public static boolean isReachable(WorldPoint from, WorldPoint to)Determines if the destination world point is reachable from the starting world point.
Parameters
from- The starting WorldPoint.
to- The destination WorldPoint.
Returns
True if the destination WorldPoint is reachable, false otherwise.
isTileMovementBlocked(WorldPoint, int)static
public static boolean isTileMovementBlocked(WorldPoint point, int worldViewId)Tests full-tile movement occupancy, independently of directional walls or path reachability.
Parameters
point- Point.
worldViewId- World view id.
isTileObstacle(WorldPoint, int)static
public static boolean isTileObstacle(WorldPoint point, int worldViewId)Full obstacle/occupancy check with the source-derived 19005696 mask, in one explicit view.
Parameters
point- Point.
worldViewId- World view id.
losTileNextTo(WorldPoint)static
public static WorldPoint losTileNextTo(WorldPoint point)Los tile next to.
Parameters
point- Point.
pathTo(Tile, Tile)static
public static List<Tile> pathTo(Tile from, Tile to)Finds a path from one tile to another and returns a list of tiles along the path.
Parameters
from- The starting tile.
to- The destination tile.
Returns
A list of tiles representing the path, or null if no path is found or if the tiles are on different planes.
pathTo(WorldPoint, WorldPoint)static
public static List<WorldPoint> pathTo(WorldPoint from, WorldPoint to)Finds a path from one world point to another and returns a list of waypoints (WorldPoints) along the path.
Parameters
from- The starting WorldPoint.
to- The destination WorldPoint.
Returns
A list of WorldPoints representing the path, or null if no path is found or if the points are on different planes.
reachableTiles()static
public static List<WorldPoint> reachableTiles()Returns a list of all reachable tiles from the player's current position using a breadth-first search algorithm.
This method considers the collision data to determine which tiles can be reached.
Returns
A list of WorldPoint objects representing all reachable tiles.
reachableTiles(WorldPoint)static
public static List<WorldPoint> reachableTiles(WorldPoint origin)Returns a list of all reachable tiles from the origins position using a breadth-first search algorithm.
This method considers the collision data to determine which tiles can be reached.
Parameters
origin- The point to query from.
Returns
A list of WorldPoint objects representing all reachable tiles from the origin.
Also allowed
Every class has these, as in plain Java.
equals, toString