mirror of
https://github.com/ppy/osu.git
synced 2024-09-24 00:47:26 +08:00
87 lines
2.8 KiB
C#
87 lines
2.8 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;
|
|
using System.Collections.Generic;
|
|
using System.Linq;
|
|
using osu.Game.Extensions;
|
|
using osu.Game.Rulesets.Objects;
|
|
|
|
namespace osu.Game.Rulesets.Edit.Checks.Components
|
|
{
|
|
public class Issue
|
|
{
|
|
/// <summary>
|
|
/// The time which this issue is associated with, if any, otherwise null.
|
|
/// </summary>
|
|
public double? Time;
|
|
|
|
/// <summary>
|
|
/// The hitobjects which this issue is associated with. Empty by default.
|
|
/// </summary>
|
|
public IReadOnlyList<HitObject> HitObjects;
|
|
|
|
/// <summary>
|
|
/// The template which this issue is using. This provides properties
|
|
/// such as the <see cref="IssueTemplate.IssueType"/>, and the
|
|
/// <see cref="IssueTemplate.UnformattedMessage"/>.
|
|
/// </summary>
|
|
public IssueTemplate Template;
|
|
|
|
/// <summary>
|
|
/// The arguments that give this issue its context, based on the
|
|
/// <see cref="IssueTemplate"/>. These are then substituted into the
|
|
/// <see cref="IssueTemplate.UnformattedMessage"/>.
|
|
/// E.g. timestamps, which diff is being compared to, what some volume is, etc.
|
|
/// </summary>
|
|
public object[] Arguments;
|
|
|
|
public Issue(IssueTemplate template, params object[] args)
|
|
{
|
|
Time = null;
|
|
HitObjects = Array.Empty<HitObject>();
|
|
Template = template;
|
|
Arguments = args;
|
|
|
|
if (template.Origin == null)
|
|
{
|
|
throw new ArgumentException(
|
|
"A template had no origin. Make sure the `Templates()` method contains all templates used."
|
|
);
|
|
}
|
|
}
|
|
|
|
public Issue(double? time, IssueTemplate template, params object[] args)
|
|
: this(template, args)
|
|
{
|
|
Time = time;
|
|
}
|
|
|
|
public Issue(HitObject hitObject, IssueTemplate template, params object[] args)
|
|
: this(template, args)
|
|
{
|
|
Time = hitObject.StartTime;
|
|
HitObjects = new[] { hitObject };
|
|
}
|
|
|
|
public Issue(IEnumerable<HitObject> hitObjects, IssueTemplate template, params object[] args)
|
|
: this(template, args)
|
|
{
|
|
var hitObjectList = hitObjects.ToList();
|
|
|
|
Time = hitObjectList.FirstOrDefault()?.StartTime;
|
|
HitObjects = hitObjectList;
|
|
}
|
|
|
|
public override string ToString()
|
|
{
|
|
return Template.Message(Arguments);
|
|
}
|
|
|
|
public string GetEditorTimestamp()
|
|
{
|
|
return Time == null ? string.Empty : Time.Value.ToEditorFormattedString();
|
|
}
|
|
}
|
|
}
|