Skip to content

bugfix: Improve POH detection by checking for portal #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kelltom wants to merge 1 commit into
base: master
Choose a base branch
from
Open

bugfix: Improve POH detection by checking for portal #45

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
113 changes: 87 additions & 26 deletions src/main/java/com/distractionreducer/DistractionReducerPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,18 +73,19 @@ public class DistractionReducerPlugin extends Plugin {
// Duke Sucellus Region ID
private static final int DUKE_SUCELLUS_REGION = 12132;

// POH Region IDs - Player-Owned Houses are instanced and use specific region ranges
private static final Set<Integer> POH_REGIONS = Set.of(
7513, // Rimmington POH
7769, // Taverley POH
7257, // Pollnivneach POH
6457, // Hosidius POH
10553, // Rellekka POH
7499, // Brimhaven POH
8013, // Yanille POH
4919 // Prifddinas POH
//region POH IDs and State
private static final Set<Integer> POH_EXIT_PORTALS = Set.of(
net.runelite.api.gameval.ObjectID.POH_EXIT_PORTAL,
net.runelite.api.gameval.ObjectID.POH_EXIT_PORTAL_WILDERNESS
);

private int cachedPohPortalX = -1;
private int cachedPohPortalY = -1;
private int cachedPohPortalPlane = -1;
private int missedPohScanRegionId = -1;
private int missedPohScanPlane = -1;
//endregion

// Updated Magic Animation IDs
private static final Set<Integer> PLANK_MAKE_ANIMATION_IDS = Set.of(6298);
private static final Set<Integer> ENCHANT_JEWELRY_ANIMATION_IDS = Set.of(
Expand Down Expand Up @@ -373,19 +374,20 @@ private boolean isSkilling() {

// Failsafe for various regions
WorldPoint playerLocation = player.getWorldLocation();
WorldView worldView = player.getWorldView();

// Check for Duke Sucellus (non-instanced)
if (playerLocation != null && playerLocation.getRegionID() == DUKE_SUCELLUS_REGION) {
return false;
}

// Check for POH (Player-Owned House) - disable overlay if not enabled in config
if (isInPOH() && !config.enableInPOH()) {
if (!config.enableInPOH() && isInPOH()) {
return false;
}

// Check for instanced regions (TOA and Duke Sucellus)
if (client.isInInstancedRegion()) {
if (worldView.isInstance()) {
WorldPoint instancePoint = WorldPoint.fromLocalInstance(client, player.getLocalLocation());
if (instancePoint != null) {
int regionID = instancePoint.getRegionID();
Expand Down Expand Up @@ -418,36 +420,95 @@ private boolean isInToaBank() {
client.getVarbitValue(Varbits.TOA_RAID_LEVEL) > 0; // Check if in an active raid
}

//region POH Logic
private boolean isInPOH() {
Player player = client.getLocalPlayer();
if (player == null) {
final Player player = client.getLocalPlayer();
if (player == null) return false;

final WorldView worldView = player.getWorldView();
if (!worldView.isInstance()) {
clearCachedPohPortal();
return false;
}

WorldPoint playerLocation = player.getWorldLocation();
if (playerLocation == null) {
final Scene scene = worldView.getScene();
final Tile[][][] tiles = scene == null ? null : scene.getTiles();
final int plane = worldView.getPlane();

if (tiles == null || plane < 0 || plane >= tiles.length) {
clearCachedPohPortal();
return false;
}

int regionID = playerLocation.getRegionID();

// Check if player is in any POH region
if (POH_REGIONS.contains(regionID)) {
final Tile[][] planeTiles = tiles[plane];
if (planeTiles == null) {
clearCachedPohPortal();
return false;
}

// Fast path 1: check cached portal location first
if (cachedPohPortalPlane == plane &&
cachedPohPortalX >= 0 && cachedPohPortalX < planeTiles.length &&
cachedPohPortalY >= 0 && cachedPohPortalY < planeTiles[0].length &&
hasPohExitPortal(planeTiles[cachedPohPortalX][cachedPohPortalY])) {
return true;
}

// Check for instanced POH (when visiting other players' houses)
if (client.isInInstancedRegion()) {
WorldPoint instancePoint = WorldPoint.fromLocalInstance(client, player.getLocalLocation());
if (instancePoint != null) {
int instanceRegionID = instancePoint.getRegionID();
return POH_REGIONS.contains(instanceRegionID);
// Hit cache is stale or missing
clearCachedPohPortal();

// Fast path 2: check region+plane miss cache
final WorldPoint instancePoint = WorldPoint.fromLocalInstance(client, player.getLocalLocation());
if (instancePoint != null) {
final int regionId = instancePoint.getRegionID();
if (regionId == missedPohScanRegionId && plane == missedPohScanPlane) {
return false;
}
}

// Slow path: full scan
for (int x = 0; x < planeTiles.length; x++) {
for (int y = 0; y < planeTiles[x].length; y++) {
if (hasPohExitPortal(planeTiles[x][y])) {
cachedPohPortalX = x;
cachedPohPortalY = y;
cachedPohPortalPlane = plane;
return true;
}
}
}

// Full scan found no portal — cache this region+plane as a miss
if (instancePoint != null) {
missedPohScanRegionId = instancePoint.getRegionID();
missedPohScanPlane = plane;
}
return false;
}

private boolean hasPohExitPortal(Tile tile) {
if (tile == null) {
return false;
}

for (GameObject obj : tile.getGameObjects()) {
if (obj != null && POH_EXIT_PORTALS.contains(obj.getId())) {
return true;
}
}

return false;
}

private void clearCachedPohPortal() {
cachedPohPortalX = -1;
cachedPohPortalY = -1;
cachedPohPortalPlane = -1;
missedPohScanRegionId = -1;
missedPohScanPlane = -1;
}
//endregion

private boolean isSmithing(int animation) {
if (SMITHING_ANIMATION_IDS.contains(animation)) {
return true;
Expand Down