SoundLoader.cs

Go to the documentation of this file.

using Microsoft.Xna.Framework.Audio;
using System;
using System.Collections.Generic;
using Terraria.Audio;

namespace Terraria.ModLoader
{
    public static class SoundLoader
    {
        private static readonly IDictionary<SoundType, int> nextSound = new Dictionary<SoundType, int>();
        internal static readonly IDictionary<SoundType, IDictionary<string, int>> sounds = new Dictionary<SoundType, IDictionary<string, int>>();
        internal static readonly IDictionary<SoundType, IDictionary<int, ModSound>> modSounds = new Dictionary<SoundType, IDictionary<int, ModSound>>();
        internal static SoundEffect[] customSounds = new SoundEffect[0];
        internal static SoundEffectInstance[] customSoundInstances = new SoundEffectInstance[0];
        public const int customSoundType = 50;
        internal static readonly IDictionary<int, int> musicToItem = new Dictionary<int, int>();
        internal static readonly IDictionary<int, int> itemToMusic = new Dictionary<int, int>();
        internal static readonly IDictionary<int, IDictionary<int, int>> tileToMusic = new Dictionary<int, IDictionary<int, int>>();

        static SoundLoader() {
            foreach (SoundType type in Enum.GetValues(typeof(SoundType))) {
                nextSound[type] = GetNumVanilla(type);
                sounds[type] = new Dictionary<string, int>();
                modSounds[type] = new Dictionary<int, ModSound>();
            }
        }

        internal static int ReserveSoundID(SoundType type) {
            int reserveID = nextSound[type];
            nextSound[type]++;
            return reserveID;
        }

        public static int SoundCount(SoundType type) {
            return nextSound[type];
        }

        public static int GetSoundSlot(SoundType type, string sound) {
            if (sounds[type].ContainsKey(sound)) {
                return sounds[type][sound];
            }
            else {
                return 0;
            }
        }

        // TODO: Should we just get rid of the soundType Enum?

        internal static LegacySoundStyle GetLegacySoundSlot(SoundType type, string sound) {
            if (sounds[type].ContainsKey(sound)) {
                return new LegacySoundStyle((int)type, sounds[type][sound]);
            }
            else {
                return null;
            }
        }

        internal static void ResizeAndFillArrays() {
            customSounds = new SoundEffect[nextSound[SoundType.Custom]];
            customSoundInstances = new SoundEffectInstance[nextSound[SoundType.Custom]];
            Array.Resize(ref Main.soundItem, nextSound[SoundType.Item]);
            Array.Resize(ref Main.soundInstanceItem, nextSound[SoundType.Item]);
            Array.Resize(ref Main.soundNPCHit, nextSound[SoundType.NPCHit]);
            Array.Resize(ref Main.soundInstanceNPCHit, nextSound[SoundType.NPCHit]);
            Array.Resize(ref Main.soundNPCKilled, nextSound[SoundType.NPCKilled]);
            Array.Resize(ref Main.soundInstanceNPCKilled, nextSound[SoundType.NPCKilled]);
            Array.Resize(ref Main.music, nextSound[SoundType.Music]);
            Array.Resize(ref Main.musicFade, nextSound[SoundType.Music]);
            foreach (SoundType type in Enum.GetValues(typeof(SoundType))) {
                foreach (string sound in sounds[type].Keys) {
                    int slot = GetSoundSlot(type, sound);
                    if (type != SoundType.Music) {
                        GetSoundArray(type)[slot] = ModContent.GetSound(sound);
                        GetSoundInstanceArray(type)[slot] = GetSoundArray(type)[slot]?.CreateInstance() ?? null;
                    }
                    else {
                        Main.music[slot] = ModContent.GetMusic(sound) ?? null;
                    }
                }
            }
        }

        internal static void Unload() {
            //for (int i = Main.maxMusic; i < Main.music.Length; i++)
            //{
            //  Main.music[i].Stop(AudioStopOptions.Immediate);
            //}
            foreach (SoundType type in Enum.GetValues(typeof(SoundType))) {
                nextSound[type] = GetNumVanilla(type);
                sounds[type].Clear();
                modSounds[type].Clear();
            }
            musicToItem.Clear();
            itemToMusic.Clear();
            tileToMusic.Clear();
        }
        //in Terraria.Main.PlaySound before checking type to play sound add
        //  if (SoundLoader.PlayModSound(type, num, num2, num3)) { return; }
        internal static bool PlayModSound(int type, int style, float volume, float pan, ref SoundEffectInstance soundEffectInstance) {
            SoundType soundType;
            switch (type) {
                case 2:
                    soundType = SoundType.Item;
                    break;
                case 3:
                    soundType = SoundType.NPCHit;
                    break;
                case 4:
                    soundType = SoundType.NPCKilled;
                    break;
                case customSoundType:
                    soundType = SoundType.Custom;
                    break;
                default:
                    return false;
            }
            if (!modSounds[soundType].ContainsKey(style)) {
                return false;
            }
            soundEffectInstance = modSounds[soundType][style].PlaySound(ref GetSoundInstanceArray(soundType)[style], volume, pan, soundType);
            return true;
        }

        internal static int GetNumVanilla(SoundType type) {
            switch (type) {
                case SoundType.Custom:
                    return 0;
                case SoundType.Item:
                    return Main.maxItemSounds + 1;
                case SoundType.NPCHit:
                    return Main.maxNPCHitSounds + 1;
                case SoundType.NPCKilled:
                    return Main.maxNPCKilledSounds + 1;
                case SoundType.Music:
                    return Main.maxMusic;
            }
            return 0;
        }

        internal static SoundEffect[] GetSoundArray(SoundType type) {
            switch (type) {
                case SoundType.Custom:
                    return customSounds;
                case SoundType.Item:
                    return Main.soundItem;
                case SoundType.NPCHit:
                    return Main.soundNPCHit;
                case SoundType.NPCKilled:
                    return Main.soundNPCKilled;
            }
            return null;
        }

        internal static SoundEffectInstance[] GetSoundInstanceArray(SoundType type) {
            switch (type) {
                case SoundType.Custom:
                    return customSoundInstances;
                case SoundType.Item:
                    return Main.soundInstanceItem;
                case SoundType.NPCHit:
                    return Main.soundInstanceNPCHit;
                case SoundType.NPCKilled:
                    return Main.soundInstanceNPCKilled;
            }
            return null;
        }
    }
}