RepoMirrors
/
osu
mirror of https://github.com/ppy/osu
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Rework template usage 

Includes moving the origin check back to templates, constructing nested template classes in each check, and making parameterized template usage.
This commit is contained in:
Naxess 2021-04-12 15:47:26 +02:00
parent a2fc9c398f
commit 7c4f6d2b62
4 changed files with 88 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
osu.Game.Rulesets.Osu/Edit/Checks/CheckOffscreenObjects.cs
View File

@ -22,29 +22,46 @@ public class CheckOffscreenObjects : ICheck
// (higher = more performant, but higher false-negative chance).
private const int path_step_size = 5;
private readonly IssueTemplateOffscreenCircle templateOffscreenCircle;
private readonly IssueTemplateOffscreenSlider templateOffscreenSlider;
private readonly IssueTemplate[] templates;
private class IssueTemplateOffscreenCircle : IssueTemplate
{
public IssueTemplateOffscreenCircle(ICheck checkOrigin)
: base(checkOrigin, IssueType.Problem, "This circle goes offscreen on a 4:3 aspect ratio.")
{
}
public Issue Create(HitCircle circle) => new Issue(circle, this);
}
private class IssueTemplateOffscreenSlider : IssueTemplate
{
public IssueTemplateOffscreenSlider(ICheck checkOrigin)
: base(checkOrigin, IssueType.Problem, "This slider goes offscreen here on a 4:3 aspect ratio.")
{
}
public Issue Create(Slider slider, double offscreenTime) => new Issue(slider, this) { Time = offscreenTime };
}
public CheckOffscreenObjects()
{
templates = new IssueTemplate[]
{
templateOffscreenCircle = new IssueTemplateOffscreenCircle(this),
templateOffscreenSlider = new IssueTemplateOffscreenSlider(this)
};
}
public CheckMetadata Metadata { get; } = new CheckMetadata
(
category: CheckCategory.Compose,
description: "Offscreen hitobjects."
);
public IEnumerable<IssueTemplate> PossibleTemplates => new[]
{
templateOffscreen,
templateOffscreenSliderPath
};
private readonly IssueTemplate templateOffscreen = new IssueTemplate
(
type: IssueType.Problem,
unformattedMessage: "This object goes offscreen on a 4:3 aspect ratio."
);
private readonly IssueTemplate templateOffscreenSliderPath = new IssueTemplate
(
type: IssueType.Problem,
unformattedMessage: "This slider goes offscreen here on a 4:3 aspect ratio."
);
public IEnumerable<IssueTemplate> PossibleTemplates => templates;
public IEnumerable<Issue> Run(IBeatmap beatmap)
{
@ -63,7 +80,7 @@ public IEnumerable<Issue> Run(IBeatmap beatmap)
case HitCircle circle:
{
if (isOffscreen(circle.StackedPosition, circle.Radius))
yield return new Issue(this, circle, templateOffscreen);
yield return templateOffscreenCircle.Create(circle);
break;
}
@ -89,7 +106,7 @@ private IEnumerable<Issue> sliderIssues(Slider slider)
// `SpanDuration` ensures we don't include reverses.
double time = slider.StartTime + progress * slider.SpanDuration;
yield return new Issue(this, slider, templateOffscreenSliderPath) { Time = time };
yield return templateOffscreenSlider.Create(slider, time);
yield break;
}
@ -98,7 +115,7 @@ private IEnumerable<Issue> sliderIssues(Slider slider)
if (!isOffscreen(slider.StackedEndPosition, slider.Radius))
yield break;
yield return new Issue(this, slider, templateOffscreenSliderPath) { Time = slider.EndTime };
yield return templateOffscreenSlider.Create(slider, slider.EndTime);
}
private bool isOffscreen(Vector2 position, double radius)

55
osu.Game/Rulesets/Edit/Checks/CheckBackground.cs
View File

@ -10,35 +10,52 @@ namespace osu.Game.Rulesets.Edit.Checks
{
public class CheckBackground : ICheck
{
private readonly IssueTemplateNoneSet templateNoneSet;
private readonly IssueTemplateDoesNotExist templateDoesNotExist;
private readonly IssueTemplate[] templates;
private class IssueTemplateNoneSet : IssueTemplate
{
public IssueTemplateNoneSet(ICheck checkOrigin)
: base(checkOrigin, IssueType.Problem, "No background has been set")
{
}
public Issue Create() => new Issue(this);
}
private class IssueTemplateDoesNotExist : IssueTemplate
{
public IssueTemplateDoesNotExist(ICheck checkOrigin)
: base(checkOrigin, IssueType.Problem, "The background file \"{0}\" does not exist.")
{
}
public Issue Create(string filename) => new Issue(this, filename);
}
public CheckBackground()
{
templates = new IssueTemplate[]
{
templateNoneSet = new IssueTemplateNoneSet(this),
templateDoesNotExist = new IssueTemplateDoesNotExist(this)
};
}
public CheckMetadata Metadata { get; } = new CheckMetadata
(
category: CheckCategory.Resources,
description: "Missing background."
);
public IEnumerable<IssueTemplate> PossibleTemplates => new[]
{
templateNoneSet,
templateDoesNotExist
};
private readonly IssueTemplate templateNoneSet = new IssueTemplate
(
type: IssueType.Problem,
unformattedMessage: "No background has been set."
);
private readonly IssueTemplate templateDoesNotExist = new IssueTemplate
(
type: IssueType.Problem,
unformattedMessage: "The background file \"{0}\" is does not exist."
);
public IEnumerable<IssueTemplate> PossibleTemplates => templates;
public IEnumerable<Issue> Run(IBeatmap beatmap)
{
if (beatmap.Metadata.BackgroundFile == null)
{
yield return new Issue(this, templateNoneSet);
yield return templateNoneSet.Create();
yield break;
}
@ -51,7 +68,7 @@ public IEnumerable<Issue> Run(IBeatmap beatmap)
if (file != null)
yield break;
yield return new Issue(this, templateDoesNotExist, beatmap.Metadata.BackgroundFile);
yield return templateDoesNotExist.Create(beatmap.Metadata.BackgroundFile);
}
}
}

17
osu.Game/Rulesets/Edit/Checks/Components/Issue.cs
View File

@ -29,7 +29,7 @@ public class Issue
/// <summary>
/// The check that this issue originates from.
/// </summary>
public ICheck Check;
public ICheck Check => Template.Check;
/// <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"/>.
@ -37,30 +37,29 @@ public class Issue
/// </summary>
public object[] Arguments;
public Issue(ICheck check, IssueTemplate template, params object[] args)
public Issue(IssueTemplate template, params object[] args)
{
Check = check;
Time = null;
HitObjects = Array.Empty<HitObject>();
Template = template;
Arguments = args;
}
public Issue(ICheck check, double? time, IssueTemplate template, params object[] args)
: this(check, template, args)
public Issue(double? time, IssueTemplate template, params object[] args)
: this(template, args)
{
Time = time;
}
public Issue(ICheck check, HitObject hitObject, IssueTemplate template, params object[] args)
: this(check, template, args)
public Issue(HitObject hitObject, IssueTemplate template, params object[] args)
: this(template, args)
{
Time = hitObject.StartTime;
HitObjects = new[] { hitObject };
}
public Issue(ICheck check, IEnumerable<HitObject> hitObjects, IssueTemplate template, params object[] args)
: this(check, template, args)
public Issue(IEnumerable<HitObject> hitObjects, IssueTemplate template, params object[] args)
: this(template, args)
{
var hitObjectList = hitObjects.ToList();

8
osu.Game/Rulesets/Edit/Checks/Components/IssueTemplate.cs
View File

@ -14,6 +14,11 @@ public class IssueTemplate
private static readonly Color4 negligible_green = new Colour4(0.33f, 0.8f, 0.5f, 1.0f);
private static readonly Color4 error_gray = new Colour4(0.5f, 0.5f, 0.5f, 1.0f);
/// <summary>
/// The check that this template originates from.
/// </summary>
public ICheck Check;
/// <summary>
/// The type of the issue.
/// </summary>
@ -26,8 +31,9 @@ public class IssueTemplate
/// </summary>
public readonly string UnformattedMessage;
public IssueTemplate(IssueType type, string unformattedMessage)
public IssueTemplate(ICheck check, IssueType type, string unformattedMessage)
{
Check = check;
Type = type;
UnformattedMessage = unformattedMessage;
}