Update xmldoc for LegacyComboIncrease

This commit is contained in:
Dean Herbert 2023-12-15 19:12:45 +09:00
parent 49f2adde25
commit 4ad312ef5b
No known key found for this signature in database

View File

@ -139,9 +139,12 @@ namespace osu.Game.Rulesets.Scoring
/// <summary>
/// A special result used as a padding value for legacy rulesets. It is a hit type and affects combo, but does not affect the base score (does not affect accuracy).
///
/// DO NOT USE FOR ANYTHING EVER.
/// </summary>
/// <remarks>
/// DO NOT USE.
/// This is used when dealing with legacy scores, which historically only have counts stored for 300/100/50/miss.
/// For these scores, we pad the hit statistics with `LegacyComboIncrease` to meet the correct max combo for the score.
/// </remarks>
[EnumMember(Value = "legacy_combo_increase")]
[Order(99)]