diff --git a/osu.Game/Overlays/Settings/SettingsSlider.cs b/osu.Game/Overlays/Settings/SettingsSlider.cs
index a7485f77cd..9fc3379b94 100644
--- a/osu.Game/Overlays/Settings/SettingsSlider.cs
+++ b/osu.Game/Overlays/Settings/SettingsSlider.cs
@@ -3,6 +3,7 @@
using System;
using osu.Framework.Graphics;
+using osu.Framework.Graphics.UserInterface;
using osu.Game.Graphics.UserInterface;
namespace osu.Game.Overlays.Settings
@@ -22,18 +23,28 @@ namespace osu.Game.Overlays.Settings
RelativeSizeAxes = Axes.X
};
+ ///
+ /// When set, value changes based on user input are only transferred to any bound control's Current on commit.
+ /// This is useful if the UI interaction could be adversely affected by the value changing, such as the position of the on the screen.
+ ///
public bool TransferValueOnCommit
{
get => ((TSlider)Control).TransferValueOnCommit;
set => ((TSlider)Control).TransferValueOnCommit = value;
}
+ ///
+ /// A custom step value for each key press which actuates a change on this control.
+ ///
public float KeyboardStep
{
get => ((TSlider)Control).KeyboardStep;
set => ((TSlider)Control).KeyboardStep = value;
}
+ ///
+ /// Whether to format the tooltip as a percentage or the actual value.
+ ///
public bool DisplayAsPercentage
{
get => ((TSlider)Control).DisplayAsPercentage;