h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2024-11-11 12:17:26 +08:00
Code Issues Releases Wiki Activity

Improve commenting around IHasCombo interfaces

Browse Source 
Following discusion with smoogi IRL.
This commit is contained in:
Dean Herbert 2023-11-22 10:44:29 +09:00
parent 7bdee96c07
commit 04640b6fb0
No known key found for this signature in database
2 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
osu.Game/Rulesets/Objects/Types/IHasCombo.cs
View File

@ -16,6 +16,12 @@ namespace osu.Game.Rulesets.Objects.Types
/// <summary> /// <summary>
/// When starting a new combo, the offset of the new combo relative to the current one. /// When starting a new combo, the offset of the new combo relative to the current one.
/// </summary> /// </summary>
/// <remarks>
/// This is generally a setting provided by a beatmap creator to choreograph interesting colour patterns
/// which can only be achieved by skipping combo colours with per-hitobject level.
///
/// It is exposed via <see cref="IHasComboInformation.ComboIndexWithOffsets"/>.
/// </remarks>
int ComboOffset { get; } int ComboOffset { get; }
} }
} }

14
osu.Game/Rulesets/Objects/Types/IHasComboInformation.cs
View File

@ -12,6 +12,9 @@ namespace osu.Game.Rulesets.Objects.Types
/// </summary> /// </summary>
public interface IHasComboInformation : IHasCombo public interface IHasComboInformation : IHasCombo
{ {
/// <summary>
/// Bindable exposure of <see cref="IndexInCurrentCombo"/>.
/// </summary>
Bindable<int> IndexInCurrentComboBindable { get; } Bindable<int> IndexInCurrentComboBindable { get; }
/// <summary> /// <summary>
@ -19,13 +22,21 @@ namespace osu.Game.Rulesets.Objects.Types
/// </summary> /// </summary>
int IndexInCurrentCombo { get; set; } int IndexInCurrentCombo { get; set; }
/// <summary>
/// Bindable exposure of <see cref="ComboIndex"/>.
/// </summary>
Bindable<int> ComboIndexBindable { get; } Bindable<int> ComboIndexBindable { get; }
/// <summary> /// <summary>
/// The index of this combo in relation to the beatmap. /// The index of this combo in relation to the beatmap.
///
/// In other words, this is incremented by 1 each time a <see cref="NewCombo"/> is reached.
/// </summary> /// </summary>
int ComboIndex { get; set; } int ComboIndex { get; set; }
/// <summary>
/// Bindable exposure of <see cref="ComboIndexWithOffsets"/>.
/// </summary>
Bindable<int> ComboIndexWithOffsetsBindable { get; } Bindable<int> ComboIndexWithOffsetsBindable { get; }
/// <summary> /// <summary>
@ -39,6 +50,9 @@ namespace osu.Game.Rulesets.Objects.Types
/// </summary> /// </summary>
new bool NewCombo { get; set; } new bool NewCombo { get; set; }
/// <summary>
/// Bindable exposure of <see cref="LastInCombo"/>.
/// </summary>
Bindable<bool> LastInComboBindable { get; } Bindable<bool> LastInComboBindable { get; }
/// <summary> /// <summary>