1
0
mirror of https://github.com/ppy/osu.git synced 2025-01-28 02:02:53 +08:00

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, MaximumBaseScore = 300,
BaseScore = 0, BaseScore = 0,
CountAccuracyJudgements = 1, AccuracyJudgementCount = 1,
ComboPortion = 0, ComboPortion = 0,
BonusPortion = 0 BonusPortion = 0
}, DateTimeOffset.Now) }, DateTimeOffset.Now)
@ -98,7 +98,7 @@ namespace osu.Game.Tests.Gameplay
{ {
MaximumBaseScore = 0, MaximumBaseScore = 0,
BaseScore = 0, BaseScore = 0,
CountAccuracyJudgements = 0, AccuracyJudgementCount = 0,
ComboPortion = 0, ComboPortion = 0,
BonusPortion = 0 BonusPortion = 0
}, DateTimeOffset.Now) }, DateTimeOffset.Now)

View File

@ -407,7 +407,7 @@ namespace osu.Game.Rulesets.Scoring
{ {
MaximumBaseScore = currentMaximumBaseScore, MaximumBaseScore = currentMaximumBaseScore,
BaseScore = currentBaseScore, BaseScore = currentBaseScore,
CountAccuracyJudgements = currentCountAccuracyJudgements, AccuracyJudgementCount = currentCountAccuracyJudgements,
ComboPortion = currentComboPortion, ComboPortion = currentComboPortion,
BonusPortion = currentBonusPortion BonusPortion = currentBonusPortion
}; };
@ -416,7 +416,7 @@ namespace osu.Game.Rulesets.Scoring
{ {
currentMaximumBaseScore = statistics.MaximumBaseScore; currentMaximumBaseScore = statistics.MaximumBaseScore;
currentBaseScore = statistics.BaseScore; currentBaseScore = statistics.BaseScore;
currentCountAccuracyJudgements = statistics.CountAccuracyJudgements; currentCountAccuracyJudgements = statistics.AccuracyJudgementCount;
currentComboPortion = statistics.ComboPortion; currentComboPortion = statistics.ComboPortion;
currentBonusPortion = statistics.BonusPortion; currentBonusPortion = statistics.BonusPortion;
} }
@ -497,18 +497,40 @@ namespace osu.Game.Rulesets.Scoring
[MessagePackObject] [MessagePackObject]
public class ScoreProcessorStatistics 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)] [Key(0)]
public double MaximumBaseScore { get; set; }
[Key(1)]
public double BaseScore { get; set; } public double BaseScore { get; set; }
[Key(2)] /// <summary>
public int CountAccuracyJudgements { get; set; } /// 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)] [Key(3)]
public double ComboPortion { get; set; } public double ComboPortion { get; set; }
/// <summary>
/// The bonus score at the current point in time.
/// </summary>
[Key(4)] [Key(4)]
public double BonusPortion { get; set; } public double BonusPortion { get; set; }
} }