Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve commenting around IHasCombo interfaces #25536

Merged
merged 1 commit into from
Nov 22, 2023
Merged

Improve commenting around IHasCombo interfaces #25536

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions osu.Game/Rulesets/Objects/Types/IHasCombo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ public interface IHasCombo
/// <summary>
/// When starting a new combo, the offset of the new combo relative to the current one.
/// </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; }
}
}
14 changes: 14 additions & 0 deletions osu.Game/Rulesets/Objects/Types/IHasComboInformation.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,31 @@ namespace osu.Game.Rulesets.Objects.Types
/// </summary>
public interface IHasComboInformation : IHasCombo
{
/// <summary>
/// Bindable exposure of <see cref="IndexInCurrentCombo"/>.
/// </summary>
Bindable<int> IndexInCurrentComboBindable { get; }

/// <summary>
/// The index of this hitobject in the current combo.
/// </summary>
int IndexInCurrentCombo { get; set; }

/// <summary>
/// Bindable exposure of <see cref="ComboIndex"/>.
/// </summary>
Bindable<int> ComboIndexBindable { get; }

/// <summary>
/// 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>
int ComboIndex { get; set; }

/// <summary>
/// Bindable exposure of <see cref="ComboIndexWithOffsets"/>.
/// </summary>
Bindable<int> ComboIndexWithOffsetsBindable { get; }

/// <summary>
Expand All @@ -39,6 +50,9 @@ public interface IHasComboInformation : IHasCombo
/// </summary>
new bool NewCombo { get; set; }

/// <summary>
/// Bindable exposure of <see cref="LastInCombo"/>.
/// </summary>
Bindable<bool> LastInComboBindable { get; }

/// <summary>
Expand Down