Skip to content

Fix sail trim highlight fallback after Red Reef update #243

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

Closed
FalseProfit wants to merge 2 commits into from
Closed

Fix sail trim highlight fallback after Red Reef update #243

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bbc79df
Use trim-window varbit for sail highlight
FalseProfit May 27, 2026
25eda70
Fix sail trim highlight fallback after Red Reef update
FalseProfit May 27, 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
49 changes: 47 additions & 2 deletions src/main/java/com/duckblade/osrs/sailing/features/facilities/LuffOverlay.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
import com.duckblade.osrs.sailing.features.util.SailingUtil;
import com.duckblade.osrs.sailing.model.Boat;
import com.duckblade.osrs.sailing.module.PluginLifecycleComponent;
import com.google.common.collect.ImmutableSet;
import java.awt.Color;
import java.awt.Dimension;
import java.awt.Graphics2D;
Expand All @@ -14,6 +15,10 @@
import lombok.extern.slf4j.Slf4j;
import net.runelite.api.Client;
import net.runelite.api.GameObject;
import net.runelite.api.GraphicsObject;
import net.runelite.api.coords.LocalPoint;
import net.runelite.api.gameval.SpotanimID;
import net.runelite.api.gameval.VarbitID;
import net.runelite.client.ui.overlay.Overlay;
import net.runelite.client.ui.overlay.OverlayLayer;
import net.runelite.client.ui.overlay.OverlayPosition;
Expand All @@ -26,6 +31,15 @@ public class LuffOverlay
extends Overlay
implements PluginLifecycleComponent
{
private static final int SAIL_VFX_DISTANCE = 512;

private static final ImmutableSet<Integer> FULL_WIND_SAIL_VFX_IDS = ImmutableSet.of(
SpotanimID.VFX_WIND_SAIL_RAFT01_FULL01,
SpotanimID.VFX_WIND_SAIL_SMALL01_FULL01,
SpotanimID.VFX_WIND_SAIL_LARGE01_FULL01,
SpotanimID.VFX_WIND_SAIL_3X10_01
);

private final Client client;
private final SailingConfig config;
private final BoatTracker boatTracker;
Expand Down Expand Up @@ -70,8 +84,7 @@ public Dimension render(Graphics2D g)
return null;
}

// Core behaviour: only show when the luff action is actually available
if (!sail.isOpShown(0))
if (!isTrimWindowActive(sail))
{
return null;
}
Expand All @@ -93,4 +106,36 @@ else if (mode == SailingConfig.SailHighlightMode.SAIL)

return null;
}

private boolean isTrimWindowActive(GameObject sail)
{
if (client.getVarbitValue(VarbitID.SAILING_BOAT_TIME_TRIM_WINDOW) > 0 ||
client.getServerVarbitValue(VarbitID.SAILING_BOAT_TIME_TRIM_WINDOW) > 0)
{
return true;
}

// The Red Reef update appears to leave this varbit unset while showing the trim window via full-wind sail vfx.
return hasFullWindSailVfx(sail);
}

private boolean hasFullWindSailVfx(GameObject sail)
{
LocalPoint sailLocation = sail.getLocalLocation();
for (GraphicsObject graphicsObject : sail.getWorldView().getGraphicsObjects())
{
LocalPoint graphicsLocation = graphicsObject.getLocation();
if (!FULL_WIND_SAIL_VFX_IDS.contains(graphicsObject.getId()) ||
graphicsObject.finished() ||
graphicsLocation == null ||
sailLocation.distanceTo(graphicsLocation) > SAIL_VFX_DISTANCE)
{
continue;
}

return true;
}

return false;
}
}