mirror of
https://github.com/ppy/osu.git
synced 2025-02-25 04:25:11 +08:00
26 lines
976 B
C#
26 lines
976 B
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 osu.Game.Rulesets.Judgements;
|
|
using osu.Game.Rulesets.Scoring;
|
|
|
|
namespace osu.Game.Rulesets.Mods
|
|
{
|
|
/// <summary>
|
|
/// Interface for a <see cref="Mod"/> with fail condition
|
|
/// </summary>
|
|
public interface IHasFailCondition
|
|
{
|
|
/// <summary>
|
|
/// Determines whether <paramref name="result"/> should trigger a failure. Called every time a
|
|
/// judgement is applied to <see cref="HealthProcessor"/>.
|
|
/// </summary>
|
|
/// <param name="result">The latest <see cref="JudgementResult"/>.</param>
|
|
/// <returns>Whether the fail condition has been met.</returns>
|
|
/// <remarks>
|
|
/// This method should only be used to trigger failures based on <paramref name="result"/>
|
|
/// </remarks>
|
|
bool FailCondition(JudgementResult result);
|
|
}
|
|
}
|