1
0
mirror of https://github.com/ppy/osu.git synced 2024-12-14 10:12:54 +08:00

Add comments for ModSelectOverlayStatics

This commit is contained in:
Cootz 2023-06-10 13:50:45 +03:00
parent 09cd5580e1
commit 31f370ec9b

View File

@ -5,6 +5,9 @@ using osu.Game.Configuration;
namespace osu.Game.Overlays.Mods
{
/// <summary>
/// Stores global mod overlay statics. These will not be stored after disposal of <see cref="ModSelectOverlay"/>
/// </summary>
public class ModSelectOverlayStatics : InMemoryConfigManager<Static>
{
protected override void InitialiseDefaults()
@ -15,6 +18,10 @@ namespace osu.Game.Overlays.Mods
public enum Static
{
/// <summary>
/// The last playback time in milliseconds of an on/off sample (from <see cref="ModSelectPanel"/>).
/// Used to debounce <see cref="ModSelectPanel"/> on/off sounds game-wide to avoid volume saturation, especially in activating mod presets with many mods.
/// </summary>
LastModSelectPanelSamplePlaybackTime
}
}