Skip to content

Suppress NPC overhead while NPC dialog is open #56

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
phyceClaw wants to merge 1 commit into
base: 1.3.0
Choose a base branch
from
Open

Suppress NPC overhead while NPC dialog is open #56

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
46 changes: 46 additions & 0 deletions src/main/java/dev/phyce/naturalspeech/SpeechEventHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,17 @@
import dev.phyce.naturalspeech.tts.VoiceID;
import dev.phyce.naturalspeech.tts.VoiceManager;
import dev.phyce.naturalspeech.utils.TextUtil;
import java.util.HashSet;
import java.util.Objects;
import java.util.Set;
import lombok.extern.slf4j.Slf4j;
import net.runelite.api.ChatMessageType;
import net.runelite.api.Client;
import net.runelite.api.NPC;
import net.runelite.api.Player;
import net.runelite.api.events.ChatMessage;
import net.runelite.api.events.OverheadTextChanged;
import net.runelite.api.events.WidgetClosed;
import net.runelite.api.events.WidgetLoaded;
import net.runelite.api.widgets.ComponentID;
import net.runelite.api.widgets.InterfaceID;
Expand All @@ -41,6 +44,10 @@ public class SpeechEventHandler {

private final ClientThread clientThread;

// NPC names that have spoken in the current dialog (tag-stripped, lowercased).
// Multi-NPC dialogs append; cleared when no dialog widget remains. Client thread only.
private final Set<String> currentDialogNpcNames = new HashSet<>();

@Inject
public SpeechEventHandler(Client client, TextToSpeech textToSpeech, NaturalSpeechConfig config,
VoiceManager voiceManager, MuteManager muteManager, SpamDetection spamDetection, ClientThread clientThread) {
Expand Down Expand Up @@ -155,6 +162,22 @@ private void onWidgetLoaded(WidgetLoaded event) {
textToSpeech.speak(voiceID, text, 0, MagicUsernames.DIALOG);
});
} else if (event.getGroupId() == InterfaceID.DIALOG_NPC) {
// Add the NPC synchronously so the very first OverheadTextChanged in this tick
// is suppressed. The name widget isn't filled in yet, but the player's interaction
// target was set the moment they clicked "Talk-to".
Player local = client.getLocalPlayer();
if (local != null && local.getInteracting() instanceof NPC) {
String n = ((NPC) local.getInteracting()).getName();
if (n != null) currentDialogNpcNames.add(Text.removeTags(n).toLowerCase());
}
// Backup: read the dialog name widget at tick end, in case interacting wasn't this NPC
// (e.g. multi-NPC scripted conversation where the talking NPC changes).
clientThread.invokeAtTickEnd(() -> {
Widget nw = client.getWidget(ComponentID.DIALOG_NPC_NAME);
if (nw != null && nw.getText() != null) {
currentDialogNpcNames.add(Text.removeTags(nw.getText()).toLowerCase());
}
});
if (!config.npcDialogEnabled()) return;
// InvokeAtTickEnd to wait until the text has loaded in
clientThread.invokeAtTickEnd(() -> {
Expand Down Expand Up @@ -205,6 +228,7 @@ private void onOverheadTextChanged(OverheadTextChanged event) {
if (!config.npcOverheadEnabled()) return;
if (isAreaDisabled()) return;
NPC npc = (NPC) event.getActor();
if (config.suppressOverheadDuringDialog() && isInDialogWith(npc)) return;
if (!muteManager.isNpcAllowed(npc)) return;

int distance = PluginHelper.getActorDistance(event.getActor());
Expand Down Expand Up @@ -457,6 +481,28 @@ private boolean checkMuteLevelThreshold(ChatMessage message) {
}


private boolean isInDialogWith(NPC npc) {
if (currentDialogNpcNames.isEmpty()) return false;
String npcName = npc.getName();
if (npcName == null) return false;
return currentDialogNpcNames.contains(Text.removeTags(npcName).toLowerCase());
}

@Subscribe
private void onWidgetClosed(WidgetClosed event) {
int group = event.getGroupId();
if (group != InterfaceID.DIALOG_NPC && group != InterfaceID.DIALOG_PLAYER) return;
// A pane closing may just be a transition to the other pane (NPC line ↔ player reply);
// defer to tick end so the new pane has had a chance to load before we decide.
clientThread.invokeAtTickEnd(() -> {
Widget npcText = client.getWidget(ComponentID.DIALOG_NPC_TEXT);
Widget playerText = client.getWidget(ComponentID.DIALOG_PLAYER_TEXT);
boolean stillOpen = (npcText != null && !npcText.isHidden())
|| (playerText != null && !playerText.isHidden());
if (!stillOpen) currentDialogNpcNames.clear();
});
}

private static int getGroupId(int component) {
return component >> 16;
}
Expand Down
12 changes: 12 additions & 0 deletions src/main/java/dev/phyce/naturalspeech/configs/NaturalSpeechConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ final class ConfigKeys {
public static final String HOLD_SHIFT_RIGHT_CLICK_MENU = "holdShiftRightClickMenu";
public static final String MUTE_GRAND_EXCHANGE_NPC_SPAM = "muteGrandExchangeNpcSpam";
public static final String FRIENDS_VOLUME_BOOST = "friendsVolumeBoost";
public static final String SUPPRESS_OVERHEAD_DURING_DIALOG = "suppressOverheadDuringDialog";
}

//<editor-fold desc="> General Settings">
Expand Down Expand Up @@ -159,6 +160,17 @@ default boolean holdShiftRightClickMenu() {
return false;
}

@ConfigItem(
position=10,
keyName=ConfigKeys.SUPPRESS_OVERHEAD_DURING_DIALOG,
name="Mute overhead text during dialogs",
description="Silence overhead chatter when dialog is open",
section=generalSettingsSection
)
default boolean suppressOverheadDuringDialog() {
return true;
}

// @ConfigItem(
// position=5,
// keyName="playbackSpeed",
Expand Down