Add xmldoc and change naming around ScoreProcessorStatistics a bit

This commit is contained in:
Dean Herbert 2023-05-29 18:38:16 +09:00
parent 57c63dbb29
commit a789d1e49c
2 changed files with 31 additions and 9 deletions

View File

@ -80,7 +80,7 @@ namespace osu.Game.Tests.Gameplay
{
MaximumBaseScore = 300,
BaseScore = 0,
CountAccuracyJudgements = 1,
AccuracyJudgementCount = 1,
ComboPortion = 0,
BonusPortion = 0
}, DateTimeOffset.Now)
@ -98,7 +98,7 @@ namespace osu.Game.Tests.Gameplay
{
MaximumBaseScore = 0,
BaseScore = 0,
CountAccuracyJudgements = 0,
AccuracyJudgementCount = 0,
ComboPortion = 0,
BonusPortion = 0
}, DateTimeOffset.Now)

View File

@ -407,7 +407,7 @@ namespace osu.Game.Rulesets.Scoring
{
MaximumBaseScore = currentMaximumBaseScore,
BaseScore = currentBaseScore,
CountAccuracyJudgements = currentCountAccuracyJudgements,
AccuracyJudgementCount = currentCountAccuracyJudgements,
ComboPortion = currentComboPortion,
BonusPortion = currentBonusPortion
};
@ -416,7 +416,7 @@ namespace osu.Game.Rulesets.Scoring
{
currentMaximumBaseScore = statistics.MaximumBaseScore;
currentBaseScore = statistics.BaseScore;
currentCountAccuracyJudgements = statistics.CountAccuracyJudgements;
currentCountAccuracyJudgements = statistics.AccuracyJudgementCount;
currentComboPortion = statistics.ComboPortion;
currentBonusPortion = statistics.BonusPortion;
}
@ -497,18 +497,40 @@ namespace osu.Game.Rulesets.Scoring
[MessagePackObject]
public class ScoreProcessorStatistics
{
/// <summary>
/// The sum of all accuracy-affecting judgements at the current point in time.
/// </summary>
/// <remarks>
/// Used to compute accuracy.
/// See: <see cref="HitResultExtensions.IsBasic"/> and <see cref="Judgement.ToNumericResult"/>.
/// </remarks>
[Key(0)]
public double MaximumBaseScore { get; set; }
[Key(1)]
public double BaseScore { get; set; }
[Key(2)]
public int CountAccuracyJudgements { get; set; }
/// <summary>
/// The maximum sum of accuracy-affecting judgements at the current point in time.
/// </summary>
/// <remarks>
/// Used to compute accuracy.
/// </remarks>
[Key(1)]
public double MaximumBaseScore { get; set; }
/// <summary>
/// The count of accuracy-affecting judgements at the current point in time.
/// </summary>
[Key(2)]
public int AccuracyJudgementCount { get; set; }
/// <summary>
/// The combo score at the current point in time.
/// </summary>
[Key(3)]
public double ComboPortion { get; set; }
/// <summary>
/// The bonus score at the current point in time.
/// </summary>
[Key(4)]
public double BonusPortion { get; set; }
}