Custom sound banks don't save to beatmap

[kstefanowicz]

Type

Game behaviour

Bug description

When using a custom soundbank (i.e. not "normal", "soft", or "drum"), the custom hitsound plays in Editor preview, but not in Test. After exiting and re-entering the editor, the HitObjects revert their soundbank back to Normal.

When the map is saved, LegacyBeatmapEncoder handles the hit object by writing the normalBank and addBank to the .osu file through getSampleBank()

private string getSampleBank(IList<HitSampleInfo> samples, bool banksOnly = false)
{
    LegacySampleBank normalBank = toLegacySampleBank(samples.SingleOrDefault(s => s.Name == HitSampleInfo.HIT_NORMAL)?.Bank);
    LegacySampleBank addBank = toLegacySampleBank(samples.FirstOrDefault(s => !string.IsNullOrEmpty(s.Name) && s.Name != HitSampleInfo.HIT_NORMAL)?.Bank);

    StringBuilder sb = new StringBuilder();

    sb.Append(FormattableString.Invariant($"{(int)normalBank}:"));
    sb.Append(FormattableString.Invariant($"{(int)addBank}"));

If the sample bank doesn't match "normal", "soft", or "drum", toLegacySampleBank() falls back to 0:

private LegacySampleBank toLegacySampleBank(string? sampleBank)
{
    switch (sampleBank?.ToLowerInvariant())
    {
        case HitSampleInfo.BANK_NORMAL:
            return LegacySampleBank.Normal;

        case HitSampleInfo.BANK_SOFT:
            return LegacySampleBank.Soft;

        case HitSampleInfo.BANK_DRUM:
            return LegacySampleBank.Drum;

        default:
            return LegacySampleBank.None;
    }
}

For a custom sample bank to save to the .osu file, presumably it'd need to save as something other than 0/1/2/3. I don't know if Stable has a fallback for that?

Screenshots or videos

custom-samplebanks-dont-save.webm

Version

2024.731.0-lazer

Logs

compressed-logs.zip