h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2025-01-28 05:22:54 +08:00
Code Issues Releases Wiki Activity

docs: add XMLDoc for methods in KCD

Browse Source
This commit is contained in:
tsrk 2023-03-08 00:58:54 +00:00
parent 44297a7d0a
commit 5b0db94a24
No known key found for this signature in database
GPG Key ID: EBD46BB3049B56D6
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
osu.Game/Screens/Play/HUD/KeyCounterDisplay.cs
View File

@ -31,6 +31,9 @@ namespace osu.Game.Screens.Play.HUD
/// </summary>
public abstract IEnumerable<KeyCounter> Counters { get; }
/// <summary>
/// Whether the actions reported by all <see cref="InputTrigger"/>s within this <see cref="KeyCounterDisplay"/> should be counted.
/// </summary>
public Bindable<bool> IsCounting { get; } = new BindableBool(true);
protected readonly Bindable<bool> ConfigVisibility = new Bindable<bool>();
@ -47,8 +50,16 @@ namespace osu.Game.Screens.Play.HUD
this.receptor = receptor;
}
/// <summary>
/// Adds a new <see cref="KeyCounter"/> to this <see cref="KeyCounterDisplay"/>.
/// </summary>
/// <param name="trigger">The <see cref="InputTrigger"/> the resulting <see cref="KeyCounter"/> will react to.</param>
public abstract void AddTrigger(InputTrigger trigger);
/// <summary>
/// Adds a range of new <see cref="KeyCounter"/>s to this <see cref="KeyCounterDisplay"/>.
/// </summary>
/// <param name="triggers">The <see cref="InputTrigger"/>s the resulting <see cref="KeyCounter"/>s will react to.</param>
public void AddTriggerRange(IEnumerable<InputTrigger> triggers) => triggers.ForEach(AddTrigger);
[BackgroundDependencyLoader]