1
0
mirror of https://github.com/ppy/osu.git synced 2025-01-12 17:23:22 +08:00

Fix and add comments

This commit is contained in:
vun 2022-07-22 10:49:53 +08:00
parent e4086b058b
commit 4433f902ea
3 changed files with 18 additions and 3 deletions

View File

@ -26,6 +26,9 @@ namespace osu.Game.Rulesets.Taiko.Difficulty.Preprocessing.Colour.Data
/// </summary> /// </summary>
public int Index; public int Index;
/// <summary>
/// How long the mono pattern encoded within is
/// </summary>
public int RunLength => EncodedData.Count; public int RunLength => EncodedData.Count;
} }
} }

View File

@ -30,12 +30,9 @@ namespace osu.Game.Rulesets.Taiko.Difficulty.Preprocessing.Colour
{ {
coupledEncoding.Payload[0].Payload[0].EncodedData[0].Colour.CoupledColourEncoding = coupledEncoding; coupledEncoding.Payload[0].Payload[0].EncodedData[0].Colour.CoupledColourEncoding = coupledEncoding;
// TODO: Review this -
// The outermost loop is kept a ForEach loop since it doesn't need index information, and we want to // The outermost loop is kept a ForEach loop since it doesn't need index information, and we want to
// keep i and j for ColourEncoding's and MonoEncoding's index respectively, to keep it in line with // keep i and j for ColourEncoding's and MonoEncoding's index respectively, to keep it in line with
// documentation. // documentation.
// If we want uniformity for the outermost loop, it can be switched to a for loop with h or something
// else as an index
// //
// While parent and index should be part of the encoding process, they are assigned here instead due to // While parent and index should be part of the encoding process, they are assigned here instead due to
// this being a simple one location to assign them. // this being a simple one location to assign them.

View File

@ -17,9 +17,24 @@ namespace osu.Game.Rulesets.Taiko.Difficulty.Preprocessing
/// </summary> /// </summary>
public class TaikoDifficultyHitObject : DifficultyHitObject public class TaikoDifficultyHitObject : DifficultyHitObject
{ {
/// <summary>
/// The list of all <see cref="TaikoDifficultyHitObject"/> of the same colour as this <see cref="TaikoDifficultyHitObject"/> in the beatmap.
/// </summary>
private readonly IReadOnlyList<TaikoDifficultyHitObject>? monoDifficultyHitObjects; private readonly IReadOnlyList<TaikoDifficultyHitObject>? monoDifficultyHitObjects;
/// <summary>
/// The index of this <see cref="TaikoDifficultyHitObject"/> in <see cref="monoDifficultyHitObjects"/>.
/// </summary>
public readonly int MonoIndex; public readonly int MonoIndex;
/// <summary>
/// The list of all <see cref="TaikoDifficultyHitObject"/> that is either a regular note or finisher in the beatmap
/// </summary>
private readonly IReadOnlyList<TaikoDifficultyHitObject> noteDifficultyHitObjects; private readonly IReadOnlyList<TaikoDifficultyHitObject> noteDifficultyHitObjects;
/// <summary>
/// The index of this <see cref="TaikoDifficultyHitObject"/> in <see cref="noteDifficultyHitObjects"/>.
/// </summary>
public readonly int NoteIndex; public readonly int NoteIndex;
/// <summary> /// <summary>