Drop the Voice-only gag method from the creation menu

It produced the exact same trigger flags as Full gag (both just set
OmitFromOutput - the "still spoken by screen reader" distinction was
never actually implemented differently), so it was a redundant choice.
Creation now only offers Full gag and Substitute. Kept the "voice"
case in add_trigger_for_gag so any gag already saved with that method
still loads and behaves the same. Updated the readme.
This commit is contained in:
OlegTheSnowman
2026-07-11 00:46:56 +03:00
parent f7477dc4c3
commit ac4a0235e2
2 changed files with 6 additions and 7 deletions

View File

@@ -126,7 +126,11 @@ function add_trigger_for_gag(gag)
if gag.method == "all" then if gag.method == "all" then
flags = flags + 4 -- OmitFromOutput flags = flags + 4 -- OmitFromOutput
elseif gag.method == "voice" then elseif gag.method == "voice" then
flags = flags + 4 -- OmitFromOutput: hidden from screen, but MushReader still speaks it -- "Voice only" was removed from the creation menu (it produced the
-- exact same trigger flags as "all" anyway - the distinction was
-- never actually implemented). Kept here so any gag saved with this
-- method before the change still loads and behaves the same.
flags = flags + 4 -- OmitFromOutput
elseif gag.method == "substitute" then elseif gag.method == "substitute" then
flags = flags + 4 -- OmitFromOutput: hide the original line flags = flags + 4 -- OmitFromOutput: hide the original line
script_name = "substitute_trigger" script_name = "substitute_trigger"
@@ -255,14 +259,12 @@ function addnewgag()
sleep(0.2) sleep(0.2)
-- Prompt 2: Gag method -- Prompt 2: Gag method
local m_choices = { local m_choices = {
"Voice only - Hide from screen, still spoken by screen reader",
"Full gag - Hide completely from screen and speech", "Full gag - Hide completely from screen and speech",
"Substitute - Replace the matched line with different text" "Substitute - Replace the matched line with different text"
} }
local m_res = utils.choose( local m_res = utils.choose(
"How should this line be gagged?\n" .. "How should this line be gagged?\n" ..
"\n" .. "\n" ..
"Voice only: The line is hidden from the screen and log, but your screen reader will still read it aloud. Good for information you want to hear but don't need cluttering the screen.\n" ..
"Full gag: The line is completely removed from both the screen and speech. Good for things you never want to see.\n" .. "Full gag: The line is completely removed from both the screen and speech. Good for things you never want to see.\n" ..
"Substitute: Replaces the matched line with your own custom text.", "Substitute: Replaces the matched line with your own custom text.",
"Step 2 of 3: Choose gag method", m_choices) "Step 2 of 3: Choose gag method", m_choices)
@@ -275,9 +277,7 @@ function addnewgag()
local gag_method = "" local gag_method = ""
local gag_sub = "" local gag_sub = ""
if m_res == "Voice only - Hide from screen, still spoken by screen reader" then if m_res == "Full gag - Hide completely from screen and speech" then
gag_method = "voice"
elseif m_res == "Full gag - Hide completely from screen and speech" then
gag_method = "all" gag_method = "all"
elseif m_res == "Substitute - Replace the matched line with different text" then elseif m_res == "Substitute - Replace the matched line with different text" then
gag_method = "substitute" gag_method = "substitute"

View File

@@ -136,7 +136,6 @@ Press **Alt + F2** to open the Gag Configuration menu. From there you can:
1. **Pattern**: Type the exact text as it appears in-game. Use `*` as a wildcard - e.g. `* hugs you` matches anyone hugging you, `You receive *` matches any "You receive ..." line. 1. **Pattern**: Type the exact text as it appears in-game. Use `*` as a wildcard - e.g. `* hugs you` matches anyone hugging you, `You receive *` matches any "You receive ..." line.
2. **Method**: 2. **Method**:
* **Voice only**: Hidden from the screen and log, but your screen reader still reads it aloud. Good for things you want to hear but don't need cluttering the screen.
* **Full gag**: Removed from both the screen and speech entirely. * **Full gag**: Removed from both the screen and speech entirely.
* **Substitute**: Replaces the matched line with your own text. Use `%1`, `%2`, etc. for wildcard matches and `%0` for the whole original line - e.g. pattern `* hugs you` with substitution `%1 pokes you` turns "warrior hugs you" into "warrior pokes you". * **Substitute**: Replaces the matched line with your own text. Use `%1`, `%2`, etc. for wildcard matches and `%0` for the whole original line - e.g. pattern `* hugs you` with substitution `%1 pokes you` turns "warrior hugs you" into "warrior pokes you".
3. **Category**: Activity, Ship, Vehicle, or Misc. This only controls grouping, so you can toggle a whole category at once - e.g. turn off all Ship gags when you're not flying. 3. **Category**: Activity, Ship, Vehicle, or Misc. This only controls grouping, so you can toggle a whole category at once - e.g. turn off all Ship gags when you're not flying.