feat(effects): Hide Message In Chat Feed effect #3189
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of the Change
This PR adds a new effect "Hide Message In Chat Feed" which will hide a chat message or command in the Firebot feed.
This effect does NOT delete or hide the message on Twitch, in any chat clients, or in any other browser effects.
Applicable Issues
Fixes #3165
I outlined some potential use cases in the issue, including the specific use case that prompted me to write this code.
Testing
I set up a conditional effect in an event handler for "Chat Message (Twitch)" to hide any message containing
hide
. This test is shown in the screenshots.(On my stream I use this to hide "trivia answers" which is basically
/^[a-dA-D]$/
when a question is active and it works in this scenario as well. And on my son's stream he uses it to hide certain commands and that also works.)Screenshots
Here's the effect in the selection:
Here's what it looks like when you are adding it. I sense the potential user confusion about why this is not hiding messages on Twitch feeds or browser overlays, and tried to head this off with the instructions on that screen. There aren't any options for this effect since the message ID is pulled from the event metadata.
For testing purposes I added this conditional effect to my "Chat Message (Twitch)" event handler:
And then I posted this in my chat on Twitch:
And saw this in the Firebot chat feed: