Skip to content

fix(MahoganyHomes): guard null home and player location in walkToHome and bank (0.0.15) #649

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

Merged
chsami merged 1 commit into from
Oct 17, 2026
Merged

fix(MahoganyHomes): guard null home and player location in walkToHome and bank (0.0.15) #649

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion src/main/java/net/runelite/client/plugins/microbot/mahoganyhomez/MahoganyHomesPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
isExternal = PluginConstants.IS_EXTERNAL
)
public class MahoganyHomesPlugin extends Plugin {
public static final String version = "0.0.14";
public static final String version = "0.0.15";
private static final List<Integer> PLANKS = Arrays.asList(ItemID.PLANK, ItemID.OAK_PLANK, ItemID.TEAK_PLANK, ItemID.MAHOGANY_PLANK);
private static final List<String> PLANK_NAMES = Arrays.asList("Plank", "Oak plank", "Teak plank", "Mahogany plank");
private static final Map<Integer, Integer> MAHOGANY_HOMES_REPAIRS = new HashMap<>();
Expand Down
41 changes: 23 additions & 18 deletions src/main/java/net/runelite/client/plugins/microbot/mahoganyhomez/MahoganyHomesScript.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -541,9 +541,8 @@ public void handleContractDialogue() {
// Bank if we need to
private void bank() {
Home currentHome = plugin.getCurrentHome();
if (currentHome != null
&& plugin.distanceBetween(currentHome.getArea(), Rs2Player.getWorldLocation()) > 0
&& isMissingItems()) {
if (isAwayFromHome(currentHome, Rs2Player.getWorldLocation())
&& isMissingItems(currentHome)) {
ShortestPathPlugin.getPathfinderConfig().setIgnoreTeleportAndItems(true);
BankLocation bankLocation = Rs2Bank.getNearestBank(currentHome.getLocation());
ShortestPathPlugin.getPathfinderConfig().setIgnoreTeleportAndItems(false);
Expand Down Expand Up @@ -582,19 +581,19 @@ && isMissingItems()) {
}
} else {
// Withdraw steel bars first if needed
if (steelBarsNeeded() > steelBarsInInventory()) {
Rs2Bank.withdrawX(ItemID.STEEL_BAR, steelBarsNeeded() - steelBarsInInventory());
if (steelBarsNeeded(currentHome) > steelBarsInInventory()) {
Rs2Bank.withdrawX(ItemID.STEEL_BAR, steelBarsNeeded(currentHome) - steelBarsInInventory());
Rs2Inventory.waitForInventoryChanges(5000);
}

// Calculate if we'll have enough space for planks after steel bars
int freeSlots = Rs2Inventory.emptySlotCount();
int currentPlanks = planksInInventory() + planksInPlankSack();
int additionalPlanksNeeded = planksNeeded() - currentPlanks;
int additionalPlanksNeeded = planksNeeded(currentHome) - currentPlanks;

if (additionalPlanksNeeded <= 0) {
// We already have enough planks
log("Already have sufficient planks: %d/%d", currentPlanks, planksNeeded());
log("Already have sufficient planks: %d/%d", currentPlanks, planksNeeded(currentHome));
} else if (freeSlots >= additionalPlanksNeeded) {
// Withdraw all planks to fill inventory
Rs2Bank.withdrawAll(plugin.getConfig().currentTier().getPlankSelection().getPlankId());
Expand All @@ -617,25 +616,31 @@ && isMissingItems()) {
// Walk to current home
private void walkToHome() {
Home currentHome = plugin.getCurrentHome();
if (currentHome != null
&& plugin.distanceBetween(currentHome.getArea(), Rs2Player.getWorldLocation()) > 0
&& !isMissingItems()) {
Rs2Walker.walkWithStateUntil(plugin.getCurrentHome().getLocation(), 3,
if (isAwayFromHome(currentHome, Rs2Player.getWorldLocation())
&& !isMissingItems(currentHome)) {
Rs2Walker.walkWithStateUntil(currentHome.getLocation(), 3,
() -> readyFurniture() != null);
if (readyFurniture() != null) fix();
}
}
private boolean isMissingItems() {
return (planksInInventory() + planksInPlankSack()) < planksNeeded()
|| steelBarsInInventory() < steelBarsNeeded();

boolean isAwayFromHome(Home home, WorldPoint playerLocation) {
return home != null
&& playerLocation != null
&& plugin.distanceBetween(home.getArea(), playerLocation) > 0;
}

private boolean isMissingItems(Home home) {
return (planksInInventory() + planksInPlankSack()) < planksNeeded(home)
|| steelBarsInInventory() < steelBarsNeeded(home);
}

private int planksNeeded() {
return plugin.getCurrentHome().getRequiredPlanks(plugin.getContractTier());
private int planksNeeded(Home home) {
return home.getRequiredPlanks(plugin.getContractTier());
}

private int steelBarsNeeded() {
return plugin.getCurrentHome().getRequiredSteelBars(plugin.getContractTier());
private int steelBarsNeeded(Home home) {
return home.getRequiredSteelBars(plugin.getContractTier());
}

private int planksInInventory() {
Expand Down
23 changes: 23 additions & 0 deletions ...test/java/net/runelite/client/plugins/microbot/mahoganyhomez/MahoganyHomesScriptTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertTrue;

class MahoganyHomesScriptTest {

Expand All @@ -24,4 +26,25 @@ void closestContractLocationPicksNearestOffice() {
assertEquals(ContractLocation.MAHOGANY_HOMES_HOSIDIUS.getLocation(),
MahoganyHomesScript.getClosestContractLocation(new WorldPoint(1760, 3600, 0)));
}

@Test
void isAwayFromHomeIsFalseWithoutHomeOrPlayerLocation() {
MahoganyHomesScript script = scriptWithPlugin();
assertFalse(script.isAwayFromHome(null, new WorldPoint(3213, 3424, 0)));
assertFalse(script.isAwayFromHome(Home.JESS, null));
assertFalse(script.isAwayFromHome(null, null));
}

@Test
void isAwayFromHomeComparesPlayerLocationToHomeArea() {
MahoganyHomesScript script = scriptWithPlugin();
assertTrue(script.isAwayFromHome(Home.JESS, new WorldPoint(3213, 3424, 0)));
assertFalse(script.isAwayFromHome(Home.JESS, new WorldPoint(2615, 3293, 1)));
}

private static MahoganyHomesScript scriptWithPlugin() {
MahoganyHomesScript script = new MahoganyHomesScript();
script.plugin = new MahoganyHomesPlugin();
return script;
}
}
Loading