Feat/mushtree and digsite transport

[Chillibloke]

New file: MagicMushtree.java - Handles all 4 Fossil Island mushtree destinations

• Modified: MountedDigsite.java - Fixed widget-based teleport selection
• Modified: Rs2Walker.java - Added mushtree handling and reachability bypass
• Modified: transports.tsv - Added 12 mushtree routes + Brimhaven dungeon entries

[coderabbitai]

Walkthrough

The PR introduces Magic Mushtree transport support for Fossil Island navigation by adding a new enum with destination mappings and object ID constants. It extends Rs2Walker to handle Magic Mushtree transports with specialized logic, including reachability check skipping and dialogue-based teleport item detection. Additionally, it updates BankLocation's CRAFTING_GUILD requirements to accept crafting capes in inventory, and performs minor refactoring in MountedDigsite.

Possibly related PRs

• Rs2Walker handleFairyRings improvements #1496: Modifies Rs2Walker's transport-handling code to add special-case flows for different transport types alongside Magic Mushtree handling
• handleInventoryTeleports with specific teleport actions #1571: Extends Rs2Walker's inventory-teleport and teleport-destination parsing, which aligns with the dialogue-based teleport item detection added here
• Poh transports added on runtime #1506: Modifies Rs2Walker's transport-handling logic to incorporate additional transport-type handling alongside Magic Mushtree support

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 40.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Feat/mushtree and digsite transport' directly reflects the main changes: adding mushtree transport support and fixing digsite transport functionality.
Description check	✅ Passed	The description is directly related to the changeset, listing the new MagicMushtree file and the three modified files with brief explanations of each change.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ast-grep (0.40.5)

runelite-client/src/main/java/net/runelite/client/plugins/microbot/util/walker/Rs2Walker.java

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🤖 Fix all issues with AI agents

In
`@runelite-client/src/main/java/net/runelite/client/plugins/microbot/shortestpath/MagicMushtree.java`:
- Around line 76-78: The code is ignoring sleepUntil's result so handleTransport
(in MagicMushtree.java) can return true even if the teleport timed out; capture
the boolean returned by sleepUntil(...) that uses
Rs2Player.getWorldLocation().distanceTo(dest) < OFFSET and return that boolean
instead of unconditionally returning true so callers get failure on timeout.

In
`@runelite-client/src/main/java/net/runelite/client/plugins/microbot/util/bank/enums/BankLocation.java`:
- Around line 129-134: The equipment check in BankLocation (variable
isWearingCraftingGuild) only calls Rs2Equipment.isWearing("crafting cape") while
the inventory check handles both "crafting cape" and "crafting cape(t)"; update
the equipment condition to also check Rs2Equipment.isWearing("crafting cape(t)")
(or extract a helper like isWearingOrInInventoryCraftingCape) so both equipment
and inventory checks treat trimmed capes consistently; modify the expression in
isWearingCraftingGuild to include the additional
Rs2Equipment.isWearing("crafting cape(t)") check.

[coderabbitai]

⚠️ Potential issue | 🟠 Major

Return failure if arrival wait times out.

sleepUntil is ignored, so handleTransport can return success even when the teleport fails or times out. Return the boolean result instead.

Proposed fix

-		// Wait until we arrive at destination
-		sleepUntil(() -> Rs2Player.getWorldLocation().distanceTo(dest) < OFFSET, 10000);
-		return true;
+		// Wait until we arrive at destination
+		return sleepUntil(() -> Rs2Player.getWorldLocation().distanceTo(dest) < OFFSET, 10000);

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	// Wait until we arrive at destination
	sleepUntil(() -> Rs2Player.getWorldLocation().distanceTo(dest) < OFFSET, 10000);
	return true;
	// Wait until we arrive at destination
	return sleepUntil(() -> Rs2Player.getWorldLocation().distanceTo(dest) < OFFSET, 10000);

🤖 Prompt for AI Agents

In
`@runelite-client/src/main/java/net/runelite/client/plugins/microbot/shortestpath/MagicMushtree.java`
around lines 76 - 78, The code is ignoring sleepUntil's result so
handleTransport (in MagicMushtree.java) can return true even if the teleport
timed out; capture the boolean returned by sleepUntil(...) that uses
Rs2Player.getWorldLocation().distanceTo(dest) < OFFSET and return that boolean
instead of unconditionally returning true so callers get failure on timeout.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Inconsistent handling of trimmed crafting cape between equipment and inventory checks.

The new inventory check on line 133 correctly handles both "crafting cape" and "crafting cape(t)", but the equipment check on line 131 only checks for "crafting cape". This means a player wearing "crafting cape(t)" would fail the equipment check but pass if they put the same cape in their inventory.

🔧 Proposed fix for consistency

                boolean isWearingCraftingGuild = (Rs2Equipment.isWearing("brown apron") || Rs2Equipment.isWearing("golden apron")) ||
                        (Rs2Equipment.isWearing("max cape") || Rs2Equipment.isWearing("max hood")) ||
-                       (Rs2Equipment.isWearing("crafting cape") || Rs2Equipment.isWearing("crafting hood"));
+                       (Rs2Equipment.isWearing("crafting cape") || Rs2Equipment.isWearing("crafting cape(t)") || Rs2Equipment.isWearing("crafting hood"));

🤖 Prompt for AI Agents

In
`@runelite-client/src/main/java/net/runelite/client/plugins/microbot/util/bank/enums/BankLocation.java`
around lines 129 - 134, The equipment check in BankLocation (variable
isWearingCraftingGuild) only calls Rs2Equipment.isWearing("crafting cape") while
the inventory check handles both "crafting cape" and "crafting cape(t)"; update
the equipment condition to also check Rs2Equipment.isWearing("crafting cape(t)")
(or extract a helper like isWearingOrInInventoryCraftingCape) so both equipment
and inventory checks treat trimmed capes consistently; modify the expression in
isWearingCraftingGuild to include the additional
Rs2Equipment.isWearing("crafting cape(t)") check.