using NetFlow.DocumentationHelper.Library.Attributes;

namespace GameDevLibrary.Extensions
{
    [Documentation("Array Extensions", "Set of extension methods to help with Arrays.")]
    public static class ArrayExtensions
    {
        // Idea obtained from TaroDev's video on things to do in Unity - https://youtu.be/Ic5ux-tpkCE?t=302
        [Documentation("Next", @"Method to obtain the next object in the array by passing the current index.
Note: Idea obtained from TaroDev's video on things to do in Unity - https://youtu.be/Ic5ux-tpkCE?t=302", new []
        {
            "CurrentIndex - The index we're currently on inside the array passed as reference so we can automatically assign to it the next index"
        })]
        public static T Next<T>(this T[] array, ref int currentIndex)
        {
            return array[currentIndex++ % array.Length];
        }
    }
}