mirror of
https://github.com/ppy/osu
synced 2025-03-03 01:49:46 +00:00
c13b93e6f1
This simplifies passing of contextual information by enabling addition without needing to refactor lots of classes. See next commit for example.
32 lines
1.2 KiB
C#
32 lines
1.2 KiB
C#
// 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.
|
|
|
|
using System.Collections.Generic;
|
|
using osu.Game.Beatmaps;
|
|
|
|
namespace osu.Game.Rulesets.Edit.Checks.Components
|
|
{
|
|
/// <summary>
|
|
/// A specific check that can be run on a beatmap to verify or find issues.
|
|
/// </summary>
|
|
public interface ICheck
|
|
{
|
|
/// <summary>
|
|
/// The metadata for this check.
|
|
/// </summary>
|
|
public CheckMetadata Metadata { get; }
|
|
|
|
/// <summary>
|
|
/// All possible templates for issues that this check may return.
|
|
/// </summary>
|
|
public IEnumerable<IssueTemplate> PossibleTemplates { get; }
|
|
|
|
/// <summary>
|
|
/// Runs this check and returns any issues detected for the provided beatmap.
|
|
/// </summary>
|
|
/// <param name="playableBeatmap">The playable beatmap of the beatmap to run the check on.</param>
|
|
/// <param name="context">The beatmap verifier context associated with the beatmap.</param>
|
|
public IEnumerable<Issue> Run(IBeatmap playableBeatmap, BeatmapVerifierContext context);
|
|
}
|
|
}
|