using System;
using Chernobyl.Extensions;

namespace Chernobyl.Generation
{
    /// <summary>
    /// Methods for producing a beat in a pattern.
    /// </summary>
    public static class Beat
    {
        /// <summary>
        /// Installs a method into the pipeline that produces a beat.
        /// </summary>
        /// <param name="factory">The method whose return values is to be replaced when a beat is required.</param>
        /// <param name="distance">The amount of space to put between each value being replaced.</param>
        /// <param name="beatFactory">The method whose return value is to do the replacing.</param>
        public static Func<T> AddBeat<T>(this Func<T> factory, int distance, Func<T> beatFactory)
            => factory.SkipReplace(distance, beatFactory);
    }
}