Skip to content

Cargo Hold Tracker: Restore Deposit-All Tracking #240

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
BBeeaarr wants to merge 2 commits into
base: main
Choose a base branch
from
+79 −0
Open

Cargo Hold Tracker: Restore Deposit-All Tracking #240

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1dcc35d
restore deposit-all functionality in CargoHoldTracker.java
BBeeaarr Mar 30, 2026
02067d2
remove refactor
BBeeaarr Mar 31, 2026
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
79 changes: 79 additions & 0 deletions src/main/java/com/duckblade/osrs/sailing/features/facilities/CargoHoldTracker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,15 @@
import net.runelite.api.events.ItemContainerChanged;
import net.runelite.api.events.MenuOptionClicked;
import net.runelite.api.events.OverheadTextChanged;
import net.runelite.api.Preferences;
import net.runelite.api.events.SoundEffectPlayed;
import net.runelite.api.events.StatChanged;
import net.runelite.api.events.WidgetLoaded;
import net.runelite.api.gameval.InterfaceID;
import net.runelite.api.gameval.InventoryID;
import net.runelite.api.gameval.ItemID;
import net.runelite.api.gameval.VarbitID;
import net.runelite.api.gameval.VarPlayerID;
import net.runelite.api.widgets.Widget;
import net.runelite.client.config.ConfigManager;
import net.runelite.client.eventbus.Subscribe;
Expand Down Expand Up @@ -118,6 +121,14 @@ public class CargoHoldTracker

private int lastXp;
private boolean pendingJenkinsAction;
//sfx variables
private boolean sfxVolumeOverridden = false;
private int previousSfxVolume = -1;
private static final int SFX_OVERRIDE_VOLUME = 1;
private static final int SFX_DEPOSIT_ALL_ID = 10905;
private static final int DEPOSIT_ALL_MAX_TICKS_TIMEOUT = 12;
Copy link
Copy Markdown
Author

@BBeeaarr BBeeaarr Mar 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

12 ticks gives ~5 seconds for the deposit to occur. Can adjust if necessary

private int depositAllTicksRemaining;
private Multiset<Integer> initialDepositAllInventory;
Copy link
Copy Markdown
Author

@BBeeaarr BBeeaarr Mar 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be able to use memoizedInventory instead here


@Inject
public CargoHoldTracker(Client client, ConfigManager configManager, BoatTracker boatTracker, CourierTaskTracker courierTaskTracker)
Expand Down Expand Up @@ -283,6 +294,11 @@ public void onGameTick(GameTick e)
{
pendingJenkinsAction = false;

if (--depositAllTicksRemaining <= 0)
{
resetDepositAllState();
}

if (--pendingInventoryAction < 0)
{
sawItemContainerUpdate = false;
Expand Down Expand Up @@ -330,6 +346,13 @@ public void onMenuOptionClicked(MenuOptionClicked e)
{
return;
}
if (e.getMenuOption().equals("Deposit-all"))
{
beginSfxOverrideIfMuted();
depositAllTicksRemaining = DEPOSIT_ALL_MAX_TICKS_TIMEOUT;
initialDepositAllInventory = getInventoryMap();
log.debug("Initial deposit-all player inventory {}", initialDepositAllInventory);
}

Widget cargoHoldWidget = client.getWidget(InterfaceID.SailingBoatCargohold.UNIVERSE); // todo confirm
if (cargoHoldWidget != null && !cargoHoldWidget.isHidden())
Expand All @@ -356,6 +379,25 @@ public void onWidgetLoaded(WidgetLoaded e)
}
}

@Subscribe
public void onSoundEffectPlayed(SoundEffectPlayed e)
{
if (sfxVolumeOverridden)
{
e.consume();
}
if (e.getSoundId() == SFX_DEPOSIT_ALL_ID && depositAllTicksRemaining > 0)
{

Multiset<Integer> deposit = Multisets.difference(initialDepositAllInventory, getInventoryMap()); // items missing from inv that were in prior snapshot
Multiset<Integer> cargoHoldToUpdate = cargoHold();
deposit.entrySet().forEach(entry -> cargoHoldToUpdate.add(entry.getElement(), entry.getCount()));
log.debug("updated cargo hold from deposit-all inventory delta {}", cargoHoldToUpdate);
writeToConfig();
resetDepositAllState();
}
}

private void resetInventoryDeltaState()
{
pendingInventoryAction = 0;
Expand Down Expand Up @@ -497,4 +539,41 @@ private void writeToConfig(int boatSlot)
log.trace("wrote cargoHold {} to config {} = {}", boatSlot, key, configValue);
}

private void setSfxVolume(int vol)
{
Preferences preferences = client.getPreferences();
preferences.setSoundEffectVolume(vol);

client.getVarps()[VarPlayerID.OPTION_SOUNDS] = vol;
client.queueChangedVarp(VarPlayerID.OPTION_SOUNDS);
}

private void beginSfxOverrideIfMuted()
{
Preferences preferences = client.getPreferences();
int current = preferences.getSoundEffectVolume();
if (current != 0 || sfxVolumeOverridden)
{
return;
}

previousSfxVolume = current;
sfxVolumeOverridden = true;

setSfxVolume(SFX_OVERRIDE_VOLUME);
}

private void resetDepositAllState()
{
if (sfxVolumeOverridden) {
// if we never captured previous, default to muted
int restore = previousSfxVolume >= 0 ? previousSfxVolume : 0;
setSfxVolume(restore);
sfxVolumeOverridden = false;
previousSfxVolume = -1;
}

depositAllTicksRemaining = 0;
initialDepositAllInventory = null;
}
}