Voice masks can now change your voice sound! #32794

beck-thompson · 2024-10-13T21:06:16Z

About the PR

Title! Same look as the verbs, but now you can also change the sound you make when you speak! This wont work for stuff like emotes, just normal speaking (Chat code 😢).

Why / Balance

Its fun and allows for some more silly antag shenanigans. You can now finally lure the CO to the weird box on bridge that totally doesn't have 5 nukies hidden inside while pretending to be a borg in distress!

Technical details

Because of the similarity to the verb dropdown, I had to refactor a lot of the verb stuff so it would work with both the verbs and the sounds! I added a lot of comments and named stuff better so it should be relatively clear what is going on.
Basic rundown:
When the window is opened VoiceMaskBoundUserInterface.cs:18,
You first load all the verbs and speech noises into their respective lists (ReloadVerbsAndNoises).
You then actually add the the verbs and speech noises to the buttons themselves in (AddVerbsAndSounds).
Whenever the state gets updated, the UpdateSelectedButtonOption gets called on both drop downs and updates the currently selected option.

Media

2024-10-13.13-21-14.mp4

UI is now updated so it looks a little better. You might also need to turn your volume up to hear whats going on!

Breaking changes

SpeechSoundsPrototypes are now required to have a (Localized) name field. Example:

- type: speechSounds
  id: Bass
  ...

is now:

- type: speechSounds
  id: Bass
  name: chat-speech-noise-name-bass
  ...

Changelog

🆑 Beck Thompson

add: Voice masks now allow you to change the sound you make when speaking!

github-actions · 2024-11-15T23:57:12Z

This pull request has conflicts, please resolve those before we can evaluate the pull request.

Aeshus

Some notes

Content.Shared/Inventory/InventorySystem.Relay.cs

Content.Shared/VoiceMask/SharedVoiceMaskSystem.cs

Resources/Locale/en-US/chat/speech-noise-names.ftl

Aeshus · 2024-11-28T17:02:57Z

Content.Client/VoiceMask/VoiceMaskNameChangeWindow.xaml.cs

+    /// <summary>
+    ///     List of all the loaded speech verbs (name, protoID).
+    /// </summary>
+    private List<(string, string)> _speechVerbs = new();


Is there a reason the type is not (string, ProtoId<?>)?

Unfortunately yes :(
It allows me make the PopulateOptionButton function usable for both! I couldn't figure out a way to make a generic protoID but if you know a way I'm all ears.

I think you could do it with something cursed with

private void PopulateOptionButton<T>(OptionButton button, string? selectedOption, List<(string, ProtoId<T>)> values) where T : class, IPrototype

Though it might make more sense to duplicate the function so that you can have a different none string for the speech sounds instead of just reusing the speech verb's for both.

Though, I'm not totally sure the added complexity is worth it.

Content.Client/VoiceMask/VoiceMaskNameChangeWindow.xaml.cs

Aeshus

Thanks for making the changes I requested earlier!

As requested by the re-requested review, I've attached more comments and changes. I also got bored and made changes to the XAML layout.

~~Enjoy!~~

Aeshus · 2024-12-21T16:24:39Z

Content.Server/VoiceMask/VoiceMaskSystem.cs

+
+        entity.Comp.VoiceMaskSpeechSound = msg.Sound;
+
+        _popupSystem.PopupEntity(Loc.GetString("voice-mask-popup-success"), entity, msg.Actor);


This LocId should be moved to VoiceMaskComponent.

Aeshus · 2024-12-21T16:27:06Z

Content.Server/Speech/SpeechNoiseSystem.cs

+            RaiseLocalEvent(ent.Owner, evt);
+
+            var protoId = evt.OverrideSpeechSound ?? ent.Comp.SpeechSounds;
+            var prototype = _protoManager.Index<SpeechSoundsPrototype>(protoId);



ProtoId is nullable here (SpeechSounds and OverrideSpeechSounds are nullable). You'll have to handle this or change some type signatures.

Aeshus · 2024-12-21T16:35:25Z

Content.Client/VoiceMask/VoiceMaskNameChangeWindow.xaml.cs

+        {
+            _speechSounds.Add((Loc.GetString(noise.Name), noise.ID));
+        }
+        _speechSounds.Sort((a, b) => a.Item1.CompareTo(b.Item1));


You should be using StringComparisons, though I'm not sure if Ordinal is the best for this case.

Suggested change

_speechSounds.Sort((a, b) => a.Item1.CompareTo(b.Item1));

_speechSounds.Sort((a, b) => string.Compare(a.Item1, b.Item1, StringComparison.Ordinal));

Aeshus · 2024-12-21T16:36:12Z

Content.Client/VoiceMask/VoiceMaskNameChangeWindow.xaml.cs

-            SpeechVerbSelector.SelectId(id);
+        // Add the default option that wont do anything when selected.
+        AddOption(button, selectedOption, Loc.GetString("chat-speech-verb-name-none"), null);
+        foreach (var (name, id) in values)


Suggested change

foreach (var (name, id) in values)

foreach (var (name, id) in values)

Aeshus · 2024-12-21T16:49:06Z

Content.Client/VoiceMask/VoiceMaskNameChangeWindow.xaml.cs

+    /// <summary>
+    ///     List of all the loaded speech verbs (name, protoID).
+    /// </summary>
+    private List<(string, string)> _speechVerbs = new();


I think you could do it with something cursed with

private void PopulateOptionButton<T>(OptionButton button, string? selectedOption, List<(string, ProtoId<T>)> values) where T : class, IPrototype

Though it might make more sense to duplicate the function so that you can have a different none string for the speech sounds instead of just reusing the speech verb's for both.

Though, I'm not totally sure the added complexity is worth it.

Aeshus · 2024-12-22T00:11:36Z

Content.Client/VoiceMask/VoiceMaskNameChangeWindow.xaml

+        <Label Text="{Loc 'voice-mask-name-change-info'}" Margin="0 0 0 10" />
+        <GridContainer Columns="2">
+            <GridContainer Rows="3" HorizontalExpand="True">
+                <LineEdit Name="NameSelector" MinWidth="175" HorizontalExpand="True" Margin="0 0 10 10" />
+                <Label Text="{Loc 'voice-mask-name-change-speech-style'}" Margin="0 0 0 5" />
+                <Label Text="{Loc 'voice-mask-name-change-speech-sound'}" />
+            </GridContainer>
+            <GridContainer Rows="3">
+                <Button Name="NameSelectorSet" Text="{Loc 'voice-mask-name-change-set'}" Margin="0 0 0 10" />
+                <OptionButton Name="SpeechVerbSelector" /> <!-- Populated in AddVerbsAndSounds -->
+                <OptionButton Name="SpeechSoundSelector" /> <!-- Populated in AddVerbsAndSounds -->
+            </GridContainer>
+        </GridContainer>
+


I had some fun playing about and made some adjustments to move the label to below the text input and make it slightly darker/smaller.

I also removed the extra GridContainer as you're meant to just list them all off (this means you won't have to do the weird hack where you have to copy the margin between the subgrids as this is what the main grid is built to do).

Suggested change

<Label Text="{Loc 'voice-mask-name-change-info'}" Margin="0 0 0 10" />

<GridContainer Columns="2">

<GridContainer Rows="3" HorizontalExpand="True">

<LineEdit Name="NameSelector" MinWidth="175" HorizontalExpand="True" Margin="0 0 10 10" />

<Label Text="{Loc 'voice-mask-name-change-speech-style'}" Margin="0 0 0 5" />

<Label Text="{Loc 'voice-mask-name-change-speech-sound'}" />

</GridContainer>

<GridContainer Rows="3">

<Button Name="NameSelectorSet" Text="{Loc 'voice-mask-name-change-set'}" Margin="0 0 0 10" />

<OptionButton Name="SpeechVerbSelector" /> 

<OptionButton Name="SpeechSoundSelector" /> 

</GridContainer>

</GridContainer>

<GridContainer Columns="2">

<LineEdit Name="NameSelector" HorizontalExpand="True" />

<Button Name="NameSelectorSet" Text="{Loc 'voice-mask-name-change-set'}" />

<Label StyleClasses="LabelSubText" Text="{Loc 'voice-mask-name-change-info'}" />

<Control /> 

<Label Text="{Loc 'voice-mask-name-change-speech-style'}" />

<OptionButton Name="SpeechVerbSelector" />

<Label Text="{Loc 'voice-mask-name-change-speech-sound'}" />

<OptionButton Name="SpeechSoundSelector" />

</GridContainer>

If you don't like the padding introduced by the Label, you can use this to trick the grid into ignoring it's width while still being able to render fine.

<Label StyleClasses="LabelSubText" Text="{Loc 'voice-mask-name-change-info'}" MaxWidth="1" HorizontalAlignment="Left" />

Aeshus · 2024-12-22T00:12:47Z

Content.Client/VoiceMask/VoiceMaskNameChangeWindow.xaml.cs

+        if (value is { } metadata)
+            button.SetItemMetadata(id, metadata);


Equivalent and less confusing:

Suggested change

if (value is { } metadata)

button.SetItemMetadata(id, metadata);

if (value is not null)

button.SetItemMetadata(id, value);

Aeshus · 2024-12-22T00:19:47Z

Content.Server/VoiceMask/VoiceMaskSystem.cs

@@ -50,6 +59,18 @@ private void OnChangeVerb(Entity<VoiceMaskComponent> entity, ref VoiceMaskChange
        UpdateUI(entity);
    }

+    private void OnChangeSound(Entity<VoiceMaskComponent> entity, ref VoiceMaskChangeSoundMessage msg)
+    {
+        if (msg.Sound is { } id && !_proto.HasIndex<SpeechSoundsPrototype>(id))


I'd probably just manually check for null for clarity rather than doing the null pattern matching syntax.

Suggested change

if (msg.Sound is { } id && !_proto.HasIndex<SpeechSoundsPrototype>(id))

if (msg.Sound is not null && !_proto.HasIndex<SpeechSoundsPrototype>(msg.Sound))

First commit

17c5fc0

github-actions bot added the Changes: UI Changes: Might require knowledge of UI design or code. label Oct 13, 2024

beck-thompson added 2 commits October 13, 2024 17:59

Better UI

350ec79

better margin

29011ad

SlamBamActionman added the S: Untriaged Status: Indicates an item has not been triaged and doesn't have appropriate labels. label Nov 14, 2024

github-actions bot added the S: Merge Conflict Status: Needs to resolve merge conflicts before it can be accepted label Nov 15, 2024

merge conflict

bec06fc

github-actions bot added size/L Denotes a PR that changes 1000-4999 lines. and removed S: Merge Conflict Status: Needs to resolve merge conflicts before it can be accepted labels Nov 17, 2024

Aeshus reviewed Nov 28, 2024

View reviewed changes

beck-thompson added 2 commits December 11, 2024 23:03

Merge branch 'master' into voice-mask-update

2008167

Address issues

fcea5a3

beck-thompson requested a review from Aeshus December 12, 2024 07:41

Aeshus suggested changes Dec 22, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Voice masks can now change your voice sound! #32794

Voice masks can now change your voice sound! #32794

beck-thompson commented Oct 13, 2024 •

edited

Loading

github-actions bot commented Nov 15, 2024

Aeshus left a comment

Aeshus Nov 28, 2024

beck-thompson Dec 12, 2024

Aeshus Dec 21, 2024

Aeshus left a comment

Aeshus Dec 21, 2024

Aeshus Dec 21, 2024

Aeshus Dec 21, 2024

Aeshus Dec 21, 2024

Aeshus Dec 21, 2024

Aeshus Dec 22, 2024

Aeshus Dec 22, 2024

Aeshus Dec 22, 2024


		entity.Comp.VoiceMaskSpeechSound = msg.Sound;

		_popupSystem.PopupEntity(Loc.GetString("voice-mask-popup-success"), entity, msg.Actor);

	_speechSounds.Sort((a, b) => a.Item1.CompareTo(b.Item1));
	_speechSounds.Sort((a, b) => string.Compare(a.Item1, b.Item1, StringComparison.Ordinal));

	foreach (var (name, id) in values)

	foreach (var (name, id) in values)

		if (value is { } metadata)
		button.SetItemMetadata(id, metadata);

	if (msg.Sound is { } id && !_proto.HasIndex<SpeechSoundsPrototype>(id))
	if (msg.Sound is not null && !_proto.HasIndex<SpeechSoundsPrototype>(msg.Sound))

Voice masks can now change your voice sound! #32794

Are you sure you want to change the base?

Voice masks can now change your voice sound! #32794

Conversation

beck-thompson commented Oct 13, 2024 • edited Loading

About the PR

Why / Balance

Technical details

Media

Breaking changes

github-actions bot commented Nov 15, 2024

Aeshus left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Aeshus left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

beck-thompson commented Oct 13, 2024 •

edited

Loading