osu-lazer/osu.Game/Beatmaps/Formats/IHasComboColours.cs

// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
// See the LICENCE file in the repository root for full licence text.

#nullable disable

using System;
using System.Collections.Generic;
using osuTK.Graphics;

namespace osu.Game.Beatmaps.Formats
{
    public interface IHasComboColours
    {
        /// <summary>
        /// Retrieves the list of combo colours for presentation only.
        /// </summary>
        IReadOnlyList<Color4> ComboColours { get; }

        /// <summary>
        /// The list of custom combo colours.
        /// If non-empty, <see cref="ComboColours"/> will return these colours;
        /// if empty, <see cref="ComboColours"/> will fall back to default combo colours.
        /// </summary>
        List<Color4> CustomComboColours { get; }

        /// <summary>
        /// Adds combo colours to the list.
        /// </summary>
        [Obsolete("Use CustomComboColours directly.")] // can be removed 20220215
        void AddComboColours(params Color4[] colours);
    }
}