Playlist.cs

Go to the documentation of this file.

using UnityEngine;
using System.Collections.Generic;

namespace HKI.Core.Audio
{
    [System.Serializable]
    [CreateAssetMenu(fileName = "Playlist", menuName = "HKI/Audio/Playlist", order = 0)]
    public class Playlist : ScriptableObject
    {
        // Public enums
        [System.Serializable]
        public enum PlaylistPlayTypes
        {
            RandomShuffelWithProtection,
            RandomShuffel,
            RandomTotal,
            Order
        }
        
        // Public variables
        [SerializeField] PlaylistPlayTypes PlaylistPlayType = PlaylistPlayTypes.RandomShuffelWithProtection;

        [SerializeField] List<SoundClip> Clips = new List<SoundClip>();

        List<int> shuffleList;

        int index = -1;

        // Getter
        public int GetNumberOfClips { get { return Clips.Count; } }

        // OnEnable function
        void OnEnable()
        {
            index = -1;

            if(PlaylistPlayType == PlaylistPlayTypes.RandomShuffelWithProtection || PlaylistPlayType == PlaylistPlayTypes.RandomShuffel)
                CreateShuffleList();
        }

        // Getter
        public PlaylistPlayTypes GetPlaylistPlayType { get { return PlaylistPlayType; } }

        // Interface functions
        public SoundClip GetNextClip()
        {
            if(Clips.Count == 0)
                return null;

            index = (index + 1) % Clips.Count;

            switch(PlaylistPlayType)
            {
                case PlaylistPlayTypes.RandomShuffelWithProtection:
                case PlaylistPlayTypes.RandomShuffel:
                    if(index == 0)
                        Shuffle();
                    return Clips[shuffleList[index]];

                case PlaylistPlayTypes.RandomTotal:
                    return Clips[Random.Range(0, Clips.Count)];

                case PlaylistPlayTypes.Order:                    
                    return Clips[index];

                default:
                    return null;
            }
        }

        public SoundClip GetClipByName(string name)
        {
            if(string.IsNullOrEmpty(name))
                return null;

            for(int i = 0; i < Clips.Count; i++)
            {
                if(Clips[i].name == name)
                    return Clips[i];
            }

            return null;
        }

        public SoundClip GetClipByClipId(int clipId)
        {
            if(string.IsNullOrEmpty(name))
                return null;

            for(int i = 0; i < Clips.Count; i++)
            {
                if (Clips[i].ClipId == clipId)
                    return Clips[i];
            }

            return null;
        }

        public void ChangeMusicPlaylist(bool playPlaylist = true)
        {
            AudioSystem.Instance.MusicAudioPlayer.ChangePlaylist(this, playPlaylist);
        }

        public void ChangeAmbientPlaylist(bool playPlaylist = true)
        {
            AudioSystem.Instance.AmbientAudioPlayer.ChangePlaylist(this, playPlaylist);
        }

        public void ChangeFxPlaylist(bool playPlaylist = false)
        {
            AudioSystem.Instance.FxAudioPlayer.ChangePlaylist(this, playPlaylist);
        }

        public void ChangeUiFxPlaylist(bool playPlaylist = false)
        {
            AudioSystem.Instance.UiFxAudioPlayer.ChangePlaylist(this, playPlaylist);
        }

        public void ChangeVoicesPlaylist(bool playPlaylist = false)
        {
            AudioSystem.Instance.VoicesAudioPlayer.ChangePlaylist(this, playPlaylist);
        }

        // Helper functions
        void Shuffle()
        {
            if(PlaylistPlayType == PlaylistPlayTypes.RandomShuffelWithProtection)
            {
                int count = Clips.Count;
                int last = count - 1;

                int lastIndex = shuffleList[last];

                for(int i = 0; i < count; ++i)
                {
                    int rand = Random.Range(i, count);
                    int tmp = shuffleList[i];
                    shuffleList[i] = shuffleList[rand];
                    shuffleList[rand] = tmp;
                }

                if(count > 1 && shuffleList[0] == lastIndex)
                {
                    int rand = Random.Range(1, count);
                    shuffleList[0] = shuffleList[rand];
                    shuffleList[rand] = lastIndex;
                }
            }
            else
            {
                int count = Clips.Count;
                int last = count - 1;
                for(int i = 0; i < count; ++i)
                {
                    int rand = Random.Range(i, count);
                    int tmp = shuffleList[i];
                    shuffleList[i] = shuffleList[rand];
                    shuffleList[rand] = tmp;
                }
            }
        }

        void CreateShuffleList()
        {
            shuffleList = new List<int>();
            for (int i = 0; i < Clips.Count; i++)
                shuffleList.Add(i);
        }
    }
}