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

Add basic xmldoc to KeyCounter classes

Browse Source
This commit is contained in:
Dean Herbert 2023-03-07 16:31:36 +09:00
parent 28520414aa
commit 97ba236eb1
3 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
osu.Game/Screens/Play/HUD/InputTrigger.cs
View File

@ -6,6 +6,9 @@ using osu.Framework.Graphics;
namespace osu.Game.Screens.Play.HUD
{
/// <summary>
/// An event trigger which can be used with <see cref="KeyCounter"/> to create visual tracking of button/key presses.
/// </summary>
public abstract partial class InputTrigger : Component
{
public event Action<bool>? OnActivate;

3
osu.Game/Screens/Play/HUD/KeyCounter.cs
View File

@ -7,6 +7,9 @@ using osu.Framework.Graphics.Containers;
namespace osu.Game.Screens.Play.HUD
{
/// <summary>
/// An individual key display which is intended to be displayed within a <see cref="KeyCounterDisplay"/>.
/// </summary>
public abstract partial class KeyCounter : Container
{
public readonly InputTrigger Trigger;

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

@ -15,6 +15,9 @@ using osuTK;
namespace osu.Game.Screens.Play.HUD
{
/// <summary>
/// A flowing display of all gameplay keys. Individual keys can be added using <see cref="InputTrigger"/> implementations.
/// </summary>
public abstract partial class KeyCounterDisplay : Container<KeyCounter>
{
/// <summary>